Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add linting to ensure worksheets are PEP8 compliant #163

Open
JoshuaWiggs opened this issue Jul 26, 2023 · 2 comments · Fixed by #165 or #171
Open

Add linting to ensure worksheets are PEP8 compliant #163

JoshuaWiggs opened this issue Jul 26, 2023 · 2 comments · Fixed by #165 or #171

Comments

@JoshuaWiggs
Copy link
Collaborator

Need to add some form of linting to ensure that all the python contained within the jupyter notebooks is PEP8 compliant and hence conforms to best practice. It is thought that this can be accomplished using black, which already has a built in jupyter hook. Ideally these checks would be automatically preformed either using pre-commit or github actions, ensuring that all future development is compliant.

@JoshuaWiggs JoshuaWiggs linked a pull request Jul 26, 2023 that will close this issue
@hsteptoe
Copy link
Collaborator

Could also consider adding codespell, flake8 and pycln?

As we're open source, we can also use the pre-commit CI https://github.com/marketplace/pre-commit-ci which is slightly more user friendly in applying the pre-commit checks IMO, but requires setting up actions.

@JoshuaWiggs
Copy link
Collaborator Author

JoshuaWiggs commented Jul 27, 2023

Added basic checking with pre-commit and black-jupyter, but should do something more sophisticated as suggested by @hsteptoe.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants