docs: README.md -- full rewrite documenting all new modules (wireless… #1
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: CI | |
| on: | |
| push: | |
| branches: [main, develop] | |
| pull_request: | |
| branches: [main] | |
| jobs: | |
| test: | |
| name: "Python ${{ matrix.python-version }} — pytest + mypy" | |
| runs-on: ubuntu-latest | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| python-version: ["3.10", "3.11", "3.12"] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| cache: pip | |
| - name: Install system dependencies | |
| run: | | |
| sudo apt-get update -qq | |
| sudo apt-get install -y libpcap-dev iproute2 | |
| - name: Install Python dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install -e ".[dev]" | |
| - name: Type-check with mypy | |
| run: mypy --config-file pyproject.toml core attacks capture dashboard wireless | |
| continue-on-error: false | |
| - name: Run tests with coverage | |
| run: | | |
| pytest \ | |
| --cov=core \ | |
| --cov=attacks \ | |
| --cov=capture \ | |
| --cov=dashboard \ | |
| --cov=wireless \ | |
| --cov-report=xml \ | |
| --cov-report=term-missing \ | |
| --cov-fail-under=80 \ | |
| -v | |
| - name: Upload coverage to Codecov | |
| uses: codecov/codecov-action@v4 | |
| with: | |
| files: coverage.xml | |
| flags: "python-${{ matrix.python-version }}" | |
| fail_ci_if_error: false | |
| lint: | |
| name: "Lint (ruff)" | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.11" | |
| cache: pip | |
| - run: pip install ruff | |
| - run: ruff check --select E,W,F --ignore E501 . | |
| docker: | |
| name: "Docker build" | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Build Docker image | |
| run: docker build -t spoof-toolkit:ci . |