Skip to content

Commit

Permalink
Migrate to Poe the Poet and Ruff for checks
Browse files Browse the repository at this point in the history
As we use Poetry for virtual environment management, we don't require
most of Nox's functionality. Poe the Poet runs more quickly, and
requires fewer lines of configuration. Ruff provides a single tool
which can replace flake8, pylint, pyupgrade, and isort, whilst
running more quickly.
  • Loading branch information
srstevenson committed Aug 20, 2023
1 parent e0c4222 commit 32efdea
Show file tree
Hide file tree
Showing 15 changed files with 238 additions and 567 deletions.
2 changes: 0 additions & 2 deletions .flake8

This file was deleted.

4 changes: 2 additions & 2 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ After cloning the repository, you can implement your changes as follows:
1. Install the project and its dependencies into an isolated virtual environment
with `poetry install`.
2. Before making your changes, run the linters and test suite with
`poetry run nox`, and ensure they pass. This checks your development
`poetry run poe check`, and ensure they pass. This checks your development
environment is correctly configured, and there aren't outstanding issues
before you start coding. If they don't pass, you can open a GitHub issue for
help debugging.
Expand All @@ -62,7 +62,7 @@ After cloning the repository, you can implement your changes as follows:
tests to prevent future regressions.
6. Ensure you've updated any docstrings or documentation files (including
`README.md`) which are affected by your change.
7. Run the linters and test suite again with `poetry run nox`, and fix any
7. Run the linters and test suite again with `poetry run poe check`, and fix any
problems.
8. Commit your changes, following [these guidelines][commit guidelines] for your
commit messages.
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ on:
pull_request:

jobs:
nox:
name: Run Nox
checks:
name: Run checks
runs-on: ubuntu-latest
strategy:
matrix:
Expand All @@ -29,8 +29,8 @@ jobs:
python3 -m pip install coverage poetry
poetry install
- name: Run Nox
run: poetry run nox
- name: Run checks
run: poetry run poe check

- name: Create XML coverage report
run: poetry run coverage xml
Expand Down
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
.ipynb_checkpoints/
/.coverage
/.mypy_cache/
/.nox/
/build/
/coverage.xml
/dist/
Expand Down
68 changes: 0 additions & 68 deletions noxfile.py

This file was deleted.

Loading

0 comments on commit 32efdea

Please sign in to comment.