ProjectPythia / ProjectPythia/projectpythia.github.io
Need content on "How to create a good Python package"
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 36
- Forks
- 25
- Avg merge
- 3d 16h
- Merged PRs (30d)
- 2
Description
Per our discussion in today's IWG meeting, I'm creating this issue as a placeholder for future work. I think that one of the Initial Content items that was neglected when discussing "Foundational Material" was the idea of how to build a "good" Python package. That would include:
- CI services like GitHub Action (for testing, linting, etc.) and ReadTheDocs (for building and hosting documentation)
- Good package structure (i.e., the structure of the files and folders in the repository)
- Using pre-commit hooks and other enforcing tools (including various pre-commit checks like black/prettier, flake8, isort, talisman, etc.)
Anything else I'm missing?
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 Initial Content item linked as #3 and the IWG discussion referenced in the issue. Define the scope of guidance for package structure, GitHub Actions, ReadTheDocs, pre-commit hooks, and the listed checks. Done means the agreed material is written and published as foundational content.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, python
- Domain
- developer-experience, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100