-
Notifications
You must be signed in to change notification settings - Fork 5
Open
Labels
lintingLinting the code baseLinting the code base
Description
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...
- Tidy up the
devsection ofproject.optional-dependenciesinpyproject.toml. Currently there is not test-suite and there are some extraneous packages in there, at a bare minimumdevshould retainruffand - Add
.pre-commit-config.yamlwith appropriate configuration options for ruff - Apply linting to the code base and resolve all issues. #11
- Ensure there is the appropriate configuration section for
pre-commit.ciin 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"
- Add
pylinttodevsection ofproject.optional-dependencies. - Add a
.pylintrcto configure howpylintruns on the repository. - Add a
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).
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
lintingLinting the code baseLinting the code base