project-generation-options.rst

Project Generation Options

project_name:

Your project's human-readable name, capitals and spaces allowed.

project_slug:

Your project's slug without dashes or spaces. Used to name your repo and in other places where a Python-importable version of your project name is needed.

description:

Describes your project and gets used in places like README.rst and such.

author_name:

This is you! The value goes into places like LICENSE and such.

email:

The email address you want to identify yourself in the project.

domain_name:

The domain name you plan to use for your project once it goes live. Note that it can be safely changed later on whenever you need to.

version:

The version of the project at its inception.

open_source_license:

A software license for the project. The choices are:

1. MIT
2. BSD
3. GPLv3
4. Apache Software License 2.0
5. Not open source

timezone:

The value to be used for the TIME_ZONE setting of the project.

windows:

Indicates whether the project should be configured for development on Windows.

use_pycharm:

Indicates whether the project should be configured for development with PyCharm.

use_docker:

Indicates whether the project should be configured to use Docker and Docker Compose.

postgresql_version:

Select a PostgreSQL version to use. The choices are:

1. 10.3
2. 10.2
3. 10.1
4. 9.6
5. 9.5
6. 9.4
7. 9.3

use_celery:

Indicates whether the project should be configured to use Celery.

use_mailhog:

Indicates whether the project should be configured to use MailHog.

use_sentry:

Indicates whether the project should be configured to use Sentry.

use_whitenoise:

Indicates whether the project should be configured to use WhiteNoise.

use_heroku:

Indicates whether the project should be configured so as to be deployable to Heroku.

use_travisci:

Indicates whether the project should be configured to use Travis CI.

use_gitlabci:

Indicates whether the project should be configured to use Gitlab CI.

use_grappelli:

Indicates whether the project should be configured to use Django Grappelli.

use_cors_headers:

Indicates whether the project should be configured to use Django CORS Headers.

keep_local_envs_in_vcs:

Indicates whether the project's .envs/.local/ should be kept in VCS (comes in handy when working in teams where local environment reproducibility is strongly encouraged).

debug:

Indicates whether the project should be configured for debugging. This option is relevant for Cookiecutter Django developers only.