Skip to content

Repository files navigation

Starting a new Python codebase?

This template takes the effort out of starting from a good place.

Getting Started

Make sure Cookiecutter is installed...

pip install cookiecutter

(or better yet, use pipx)

pipx install cookiecutter

...use it to render the project...

cookiecutter gh:ADACS-Australia/adacs_template_python_base

...answer the questions...

ADACS Python Template Questions

...and configure the services you need using these instructions.

What do you get for this?

A codebase that eases collaboration and automatically:

  • Ensures that all commits on the main branch and released versions build correctly and pass all unit tests
  • Enforces code formatting and linting policies
  • Manages code and release versioning
  • (optionally) publishes your code to PyPI so people can easilly install it
  • (optionally) updates, builds and publishes documentation to Read the Docs.

Other ADACS Python templates can then be applied to this base template to quickly kickstart a new project.

About

ADACS Python Template

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages