Skip to main content

This is a template for python projects.

Project description

Python Project Template

This is a template repository for python project.

check GitHub document aboud template repository.

CI/CD

Python package readthedocs build status pre-commit CodeQL License: MIT PyPI version Github pages

for detail about badges, see

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

Documenting

You can use documenting tools like

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

python-project-templates-0.1.4.tar.gz (6.5 kB view hashes)

Uploaded Source

Built Distribution

python_project_templates-0.1.4-py3-none-any.whl (5.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page