The recently added switch to pyproject.toml (see #7 ) included configuration options for the ruff.
The easiest way to add this to the development workflow is via pre-commit and pre-commit.ci which runs the checks as part of the Continuous Integration.
Tasks to complete...
[x] Tidy up the dev section of project.optional-dependencies in pyproject.toml. Currently there is not test-suite and there are some extraneous packages in there, at a bare minimum dev should retain ruff and
[x] Add .pre-commit-config.yaml with appropriate configuration options for ruff
[ ] #11
[x] Ensure there is the appropriate configuration section for pre-commit.ci in the .pre-commit-config.yaml
[ ] Allow permission for pre-commit.ci to run on this repository.
Might also be worth linting the code with pylint as ruff doesn't always pick up all the "code smells"
[x] Add pylint to dev section of project.optional-dependencies.
[x] Add a .pylintrc to configure how pylint runs on the repository.
[x] Add a local hook to .pre-commit-config.yaml and ensure this is excluded from pre-commit.ci (typically required because the environment that runs on pre-commit.ci won't have all of the required dependencies to run the linting).
The recently added switch to
pyproject.toml(see #7 ) included configuration options for the ruff.The easiest way to add this to the development workflow is via pre-commit and pre-commit.ci which runs the checks as part of the Continuous Integration.
Tasks to complete...
devsection ofproject.optional-dependenciesinpyproject.toml. Currently there is not test-suite and there are some extraneous packages in there, at a bare minimumdevshould retainruffand.pre-commit-config.yamlwith appropriate configuration options for ruffpre-commit.ciin the.pre-commit-config.yamlMight also be worth linting the code with pylint as
ruffdoesn't always pick up all the "code smells"pylinttodevsection ofproject.optional-dependencies..pylintrcto configure howpylintruns on the repository.localhook to.pre-commit-config.yamland ensure this is excluded frompre-commit.ci(typically required because the environment that runs onpre-commit.ciwon't have all of the required dependencies to run the linting).