MetOffice / MetOffice/PyPRECIS
Add linting to ensure worksheets are PEP8 compliant
A pull request for this has already been merged.
- Dominant language
- Jupyter Notebook
- Stars
- 20
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Description
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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the repository's Jupyter notebooks and any existing pre-commit or GitHub Actions configuration, then consult the linked Black Jupyter integration guidance. Done means Python in the notebooks is checked for PEP8-compatible formatting automatically for future changes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter-notebook, python
- Domain
- ci-cd, testing-qa, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100