Cookiecutter Django App

Cookiecutter Django App allows you to build modern apps with pre-configured development environment.

Features

• Poetry - packaging and dependencies manager.
• GitHub actions - CI / CD for GitHub.
• Testing with pytest and tox.
• Code quality with black and isort.
• Shpinx docs.
• Pre-configured semantic version bumper.

Getting started

1. Create new project:

   $ cookiecutter https://github.com/OpenWiden/cookiecutter-django-app
   repo_name [django-app-name]: django-gitlab-webhooks
   project_description [App for Django.]: Gitlab webhooks for Django.
   author [my_name_or_nick_name]: stefanitsky
   email [my_email@email.com]: stefanitsky.mozdor@gmail.com
   app_name [app_name]: gitlab_webhooks
   app_version [0.1.0]:
   app_config_name [GitlabWebhooksConfig]:
   

2. Register on `Codecov https://codecov.io/gh`_ and add Repository Upload Token from settings to GitHub repository secrets with name CODECOV_TOKEN.

3. Register on PyPi, create API token and add it to GitHub repository secrets with name PYPI_TOKEN.

4. Change urls for badges in README.rst if it's required.

5. Create project repository on GitHub.

6. Push local repositoriy:

   $ git init
   $ git add .
   $ git commit -m ':tada: initial commit'
   $ git remote add origin https://github.com/{{cookiecutter.author}}/{{cookiecutter.repo_name}}.git
   $ git push -u origin master
   

7. Register on Read the Docs and add your repository for auto docs create.