Python project checklist¶
This checklist covers major considerations when creating a high-quality, maintainable, reusable Python codebase. It is designed to be used along with a RSE to guide you through it (it is in a draft stage, and doesn’t have link to what these mean). Not everything is expected for every project, but a sufficiently advanced complicated project will have most of these things.
Citeability and credit, authorship discussion
In use locally
In use on some platform (Github/Gitlab/etc)
Discuss issue tracker
Make one example pull request
Standard project layout
Command line or other standard interface
(relates to packaging below)
Simple system tests on basic examples
More fine-grained integration or unit tests
Forms / levels
README file: good enough?
Read The Docs
How to / simple examples to copy