Content on "How to create a Python package"
@anissa111 is already working on this.
Since Jun 28, 2022.
Assessment
This issue has not been assessed yet.
Description
Migrating an interesting discussion over from https://github.com/ProjectPythia/projectpythia.github.io/issues/43.
I think that the Foundations book could have an entirely new top-level section (after Core Scientific Packages) devoted to best practices for developing Python packages.
Tentatively, the chapter could be entitled "Building Python Packages", and have sections like:
- tutorial on tests and testing
- Good package structure (i.e., the structure of the files and folders in the repository)
- Building documentation
- CI services like GitHub Action (for testing, linting, etc.) and ReadTheDocs (for building and hosting documentation)
- Using pre-commit hooks and other enforcing tools (including various pre-commit checks like black/prettier, flake8, isort, talisman, etc.)
I'm not 100% sure if this is in-scope for the Foundations book, but it could be really useful to have self-contained tutorials on all this material cross-referenced with our tutorials on conda, git, GitHub pull requests, etc.
- Dominant language
- Jupyter Notebook
- Stars
- 72
- Forks
- 60
- Avg merge
- 17h 36m
- Merged PRs (30d)
- 2
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.
More from ProjectPythia/pythia-foundations
-
infrastructure
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
-
infrastructure
Difficulty 4/5 Over a week Newbie friendliness 35/100
-
content JOSE revision
Difficulty 1/5 Under an hour Newbie friendliness 55/100
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
ProjectPythia/pythia-foundations#580 · 1 reaction ·
-
content
Difficulty 2/5 1-3 hours Newbie friendliness 35/100