/cookiecutter-djangopackage

An opinionated Cookiecutter template for creating reusable Django packages (installable apps) quickly.

Primary LanguagePythonBSD 3-Clause Clear LicenseBSD-3-Clause-Clear

Cookiecutter Django Package

An opinionated Cookiecutter template for creating reusable Django packages (installable apps) quickly.

Features

  • Uses Pipenv to manage dependencies and environments.
  • Tox setup compatible with Pipenv.
  • Travix-CI configuration compatible with Tox.
  • Sphinx documentation template.
  • Code Coverage measured.
  • BSD Clear License.
  • Creates example project for quick development.

Usage

$ git clone https://github.com/jmfederico/cookiecutter-djangopackage.git
$ cd cookiecutter-djangopackage
$ pip install pipenv
$ pipenv install
$ pipenv run cookiecutter .

Now you can develop you app.

Releasing on PyPI

Time to release a new version? Easy!

First, use bumpversion to up the release number

$ bumpversion --current-version VERSION_NUMBER minor --config-file setup.cfg

Where VERSION_NUMBER is the current version, e.g. 0.1.0.

Then run

$ make release

You probably want to also tag the version now

$ git tag -a v0.1.0 -m 'Version 0.1.0'
$ git push --tags

Go ahead and follow those instructions.

Add to Django Packages

Once you have a release just go to Django Packages and add it there.

Credits

Based on: