[x] Installation The package can be installed from a community repository such as PyPI (preferred), and/or a community channel on conda (e.g. conda-forge, bioconda).
[x] The package imports properly into a standard Python environment import package.
[x] Fit The package meets criteria for fit and overlap.
[x] Documentation The package has sufficient online documentation to allow us to evaluate package function and scope without installing the package. This includes:
[x] User-facing documentation that overviews how to install and start using the package.
[x] Short tutorials that help a user understand how to use the package and what it can do for them.
[x] API documentation (documentation for your code's functions, classes, methods and attributes): this includes clearly written docstrings with variables defined using a standard docstring format.
[x] Core GitHub repository Files
[x] README The package has a README.md file with clear explanation of what the package does, instructions on how to install it, and a link to development instructions.
[x] Contributing File The package has a CONTRIBUTING.md file that details how to install and contribute to the package.
[x] Code of Conduct The package has a CODE_OF_CONDUCT.md file.
[x] License The package has an OSI approved license.
NOTE: We prefer that you have development instructions in your documentation too.
[x] Issue Submission Documentation All of the information is filled out in the YAML header of the issue (located at the top of the issue template).
[x] Automated tests Package has a testing suite and is tested via a Continuous Integration service.
[x] Repository The repository link resolves correctly.
[x] Package overlap The package doesn't entirely overlap with the functionality of other packages that have already been submitted to pyOpenSci.
rcaneill
commented
6 months ago
import package.README.mdfile with clear explanation of what the package does, instructions on how to install it, and a link to development instructions.CONTRIBUTING.mdfile that details how to install and contribute to the package.CODE_OF_CONDUCT.mdfile.YAMLheader of the issue (located at the top of the issue template).