A template for a repository that contains a Python module.
As well as the template structure, this repository contains some notes, resources, and standards for developing and structuring Python modules.
This template assumes that sphinx is being used for documentation.
The following are other available resources for developing a Python module:
- The shablona template is a nice template for small scientific Python modules
The folders in this template are organized as follows:
doc: configuration and content files for making the documentation websitemodcode: the source code of the module (renamed to reflect the module name)examplesand/ortutorials: examples and tutorials for using the module
Individual files have notes within them detailing what they are for.
The repository should include a descriptive README in the base folder.
Suggested sections in the README are as follows:
A brief description of the project.
This can / should include a list of the sub-modules.
Links to and brief descriptions of the available documentation.
This can / should include a list of the available pages on the documentation website.
Notes on the requirements for installing and using this module.
This should include programming language, major version required, and a list of dependencies.
Notes and instructions on installing the module.
Links to the reference for the project, such as a preprint or paper.
Notes on how to interact with and potentially contribute to the project.
This section should link to the CONTRIBUTING page, and note the CODE_OF_CONDUCT.