Python Project Template

This is a template repository for python project.

check GitHub document aboud template repository.

CI/CD

for detail about badges, see

• GitHub documentation
• readthedocs build badges

This project is integrated with ./scripts/ci.sh
You should run the script every time before git commit.

docker environment

Use docker to avoid annoying environment conflicts.
First, you must set the project name in docker/.env file.
then you can run docker-compose up -d command to build an docker image with default Dockerfile.

$ cd docker \
    && docker-compose up -d

for details about docker, see official documentations

• Docker
• Docker Compose

Documenting

You can use documenting tools like

• sphinx
• mkdocs

and host it on readthedocs

Python Project Template ‘s documentation

sphinx

shpinx-apidoc

generate document with sphinx-apidoc command. script

configurations (todo)

sphinx extensions https://www.sphinx-doc.org/en/master/usage/extensions/index.html

napoleon https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html#module-sphinx.ext.napoleon

numpy style https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard

google style https://github.com/google/styleguide/blob/gh-pages/pyguide.md#38-comments-and-docstrings

publish package to Pypi

hit this command on terminal to publish the current version to Pypi.

$ ./scripts/publish.sh

• auto updating with github actions is coming soon.

Quick Start using this template.

• edit project name for docker environment.
• edit project configuration
  • edit pyproject.toml’s metadata section.
  • delete such as tool.poetry.scripts and so on needless.
• edit documentation configuration.
  • docs/_*.conf.py files.
  • scripts/generate_sphinx_docs_headers.py
  • .readthedocs.yaml’s sphinx.configuration option (optional).
• Rewrite your own project README.
• delete src/package_* directories.
• now it’s time to start make your own package.