docs: add comprehensive README with CI badge, results, B2B toolkit se… #21
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", "master"] | |
| pull_request: | |
| branches: ["main", "master"] | |
| jobs: | |
| test: | |
| name: "pytest · Python ${{ matrix.python-version }} · ${{ matrix.os }}" | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: [ubuntu-latest, windows-latest] | |
| python-version: ["3.10", "3.11", "3.12"] | |
| steps: | |
| - name: Checkout repository | |
| 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 runtime dependencies | |
| run: pip install -r requirements.txt | |
| - name: Install dev dependencies | |
| run: pip install -r requirements-dev.txt | |
| # Playwright binaries are only needed for browser_utils integration tests. | |
| # The unit-test suite (test_core.py) does NOT require them, so we skip | |
| # the install here to keep CI fast. Add this step if you add browser tests. | |
| # - name: Install Playwright Chromium | |
| # run: python -m playwright install chromium --with-deps | |
| - name: Run tests with coverage | |
| run: pytest --tb=short -v --cov=core --cov=enricher --cov-report=term-missing | |
| - name: Upload coverage report (Ubuntu / Python 3.12 only) | |
| if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.12' | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: coverage-report | |
| path: .coverage |