Skip to content

Commit

Permalink
Merge branch 'release/0.8.0'
Browse files Browse the repository at this point in the history
  • Loading branch information
SkypLabs committed Mar 22, 2022
2 parents bcf1ede + cb47175 commit 1c0bc2a
Show file tree
Hide file tree
Showing 69 changed files with 2,045 additions and 1,688 deletions.
1 change: 0 additions & 1 deletion .github/FUNDING.yml

This file was deleted.

20 changes: 20 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
version: 2
updates:

- package-ecosystem: pip
directory: "/"
schedule:
interval: weekly
time: "09:00"
timezone: Europe/Dublin
open-pull-requests-limit: 10
target-branch: develop

- package-ecosystem: github-actions
directory: "/"
schedule:
interval: weekly
time: "09:00"
timezone: Europe/Dublin
open-pull-requests-limit: 10
target-branch: develop
28 changes: 24 additions & 4 deletions .github/settings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,10 @@ repository:

labels:
- name: feature
oldname: enhancement
description: New feature
color: 84b6eb
- name: optimisation
description: Optimisation
- name: enhancement
description: Enhancement
color: 84b6eb
- name: refactor
description: Refactoring
Expand All @@ -36,6 +35,15 @@ labels:
- name: ui
description: Related to the user interface
color: 1d76db
- name: exporters
description: Related to the exporters
color: 1d76db
- name: cli
description: Related to the CLI tool
color: 1d76db
- name: dependencies
description: Related to the dependencies
color: 1d76db

- name: android
description: Android platform support issues
Expand Down Expand Up @@ -81,9 +89,21 @@ labels:
color: 33aa3f

- name: documentation
description: Documentation-related issue
description: Related to the documentation
color: 2d2de2

- name: packaging
description: Related to software packaging
color: 31f427

- name: testing
description: Related to software testing
color: efa5ef

- name: ci/cd
description: Related to CI/CD
color: e85733

- name: good first issue
description: Good first issue
color: 7057ff
Expand Down
118 changes: 118 additions & 0 deletions .github/workflows/test_and_publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
name: Test and Publish

on:
- push
- pull_request

jobs:
test-code:
name: Test code
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [ubuntu-20.04, macos-10.15]
python-version:
- '3.7'
- '3.8'
- '3.9'
- '3.10'

steps:
- name: Check out code
uses: actions/checkout@v3

- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v3
with:
python-version: ${{ matrix.python-version }}

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install .[tests] tox-gh-actions
- name: Test with Tox
run: tox

test-docs:
name: Test documentation
runs-on: ubuntu-20.04
env:
PYTHON_VERSION: '3.x'
steps:
- name: Check out code
uses: actions/checkout@v3

- name: Set up Python ${{ env.PYTHON_VERSION }}
uses: actions/setup-python@v3
with:
python-version: ${{ env.PYTHON_VERSION }}

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install .[docs]
- name: Build documentation
working-directory: docs
run: make html

publish-to-test-pypi:
name: Publish to TestPyPI
environment: staging
runs-on: ubuntu-20.04
if: github.ref == 'refs/heads/main' && github.event_name == 'push'
needs:
- test-code
- test-docs

steps:
- name: Check out code
uses: actions/checkout@v3

- name: Set up Python
uses: actions/setup-python@v3
with:
python-version: '3.x'

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install --upgrade setuptools wheel twine build
- name: Build and publish
env:
TWINE_USERNAME: '__token__'
TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
run: |
python -m build
twine upload --repository testpypi dist/*
publish-to-pypi:
name: Publish to PyPI
environment: production
runs-on: ubuntu-20.04
if: github.ref == 'refs/heads/main' && github.event_name == 'push'
needs: publish-to-test-pypi

steps:
- name: Check out code
uses: actions/checkout@v3

- name: Set up Python
uses: actions/setup-python@v3
with:
python-version: '3.x'

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install --upgrade setuptools wheel twine build
- name: Build and publish
env:
TWINE_USERNAME: '__token__'
TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
run: |
python -m build
twine upload dist/*
17 changes: 17 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
version: 2

build:
os: ubuntu-20.04
tools:
python: "3"

python:
install:
- method: pip
path: .
extra_requirements:
- complete
- docs

sphinx:
configuration: docs/conf.py
5 changes: 0 additions & 5 deletions .readthedocs.yml

This file was deleted.

2 changes: 0 additions & 2 deletions .snyk

This file was deleted.

31 changes: 0 additions & 31 deletions .travis.yml

This file was deleted.

61 changes: 56 additions & 5 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,54 @@
# Changelog

## v0.8.0 - Mar 22, 2022

### Breaking Changes

* The PNL view has been removed.

### Improvements

* Add `pyproject.toml` and `setup.cfg`
* Remove argparse from dependencies (@fabaff)
* Use f-strings instead of `str.format()`
* Add support for Python 3.8, 3.9 and 3.10
* Drop support for Python 3.4, 3.5 and 3.6
* Make some dependencies optional
* Refactor code around Scapy's PipeTools
* Add metavars to argument parser
* Turn `interface` option into argument
* Cache the compiled regex in `Config` once computed
* Cache the frame filter in `Config` once computed
* Cache the MAC address' OUI in `ProbeRequest`
* Use the logging package
* Add extra dependency group `tests`
* Add unit tests for the argument parser
* Add `__version__` attribute to package
* Use an entry point to generate the CLI tool
* Use tox for unit testing

### Fixes

* Fix interface checking
* Close open files before exiting
* Use a fake `Config` object in unit tests
* Fix linting issues

### Infrastructure

* Upgrade RTD configuration file to version 2
* Monitor GH Actions dependencies with Dependabot
* Use `main` as branch for production releases
* Upgrade to GitHub-native Dependabot
* Add macOS to build matrix
* Switch from Travis CI to GitHub Actions

## v0.7.2 - Aug 26, 2019

### Improvements

* Use the new [Scapy built-in asynchronous sniffer](https://scapy.readthedocs.io/en/latest/usage.html#asynchronous-sniffing)
* Use the new [Scapy built-in asynchronous
sniffer](https://scapy.readthedocs.io/en/latest/usage.html#asynchronous-sniffing)
* Introduce the new `Config` object containing the configuration of ProbeQuest

### Fixes
Expand All @@ -17,8 +63,10 @@

### Fixes

* Error when trying to decode ESSIDs using invalid UTF-8 characters ([#4](https://github.com/SkypLabs/probequest/issues/4))
* Arguments not working (-e, -r) ([#17](https://github.com/SkypLabs/probequest/issues/17))
* Error when trying to decode ESSIDs using invalid UTF-8 characters
([#4](https://github.com/SkypLabs/probequest/issues/4))
* Arguments not working (-e, -r)
([#17](https://github.com/SkypLabs/probequest/issues/17))

## v0.7.0 - Oct 8, 2018

Expand All @@ -34,7 +82,9 @@

### Fixes

* Test if a packet has a `Dot11ProbeReq` layer before parsing it ([#5](https://github.com/SkypLabs/probequest/issues/5), [#8](https://github.com/SkypLabs/probequest/issues/8))
* Test if a packet has a `Dot11ProbeReq` layer before parsing it
([#5](https://github.com/SkypLabs/probequest/issues/5),
[#8](https://github.com/SkypLabs/probequest/issues/8))

## v0.6.1 - May 28, 2018

Expand Down Expand Up @@ -71,7 +121,8 @@ The project has been renamed to ProbeQuest.

### Fixes

* The sniffer stops after having received the first frame ([#3](https://github.com/SkypLabs/probequest/issues/3))
* The sniffer stops after having received the first frame
([#3](https://github.com/SkypLabs/probequest/issues/3))

## v0.5.0 - Feb 7, 2018

Expand Down
Loading

0 comments on commit 1c0bc2a

Please sign in to comment.