cookiecutter/cookiecutter-django
1
1
Fork 0
mirror of https://github.com/cookiecutter/cookiecutter-django.git synced 2024-11-11 04:07:48 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update project generation options docs

Browse Source
This commit is contained in:
Nikita P. Shupeyko 2018-03-05 13:54:35 +03:00
parent f582aa1a84
commit e4353a41ed
1 changed files with 86 additions and 72 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

158
docs/project-generation-options.rst
View File

@ -1,69 +1,61 @@
Project Generation Options Project Generation Options
========================== ==========================
project_name [project_name]: project_name [My Awesome Project]:
Your human-readable project name, including any capitalization or spaces. Your project's human-readable name, capitals and spaces allowed.
project_slug [project_name]: project_slug [my_awesome_project]:
The slug of your project, without dashes or spaces. Used to name your repo 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 and in other places where a Python-importable version of your project name
is needed. is needed.
author_name [Your Name]: description [Behold My Awesome Project!]
You! This goes into places like the LICENSE file. Describes your project and gets used in places like `README.rst` and such.
email [Your email]: author_name [Daniel Roy Greenfeld]:
Your email address. This is you! The value goes into places like `LICENSE` and such.
description [A short description of the project.] email [daniel-roy-greenfeld@example.com]:
Used in the generated README.rst and other places. The email address you want to identify yourself in the project.
domain_name [example.com] domain_name [example.com]
Whatever domain name you plan to use for your project when it goes live. The domain name you plan to use for your project ones it goes live.
Note that it can be safely changed later on whenever you need to.
version [0.1.0] version [0.1.0]
The starting version number for your project. The version of the project at its inception.
open_source_license [1]
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 [UTC] timezone [UTC]
Used in the base settings file for the `TIME_ZONE` value. The value to be used for the `TIME_ZONE` setting of the project.
use_whitenoise [y]
Whether to use WhiteNoise_ for static file serving.
use_celery [n]
Whether to use Celery_. This gives you the ability to use distributed task
queues in your project.
use_mailhog [n]
Whether to use MailHog_. MailHog is a tool that simulates email receiving
for development purposes. It runs a simple SMTP server which catches
any message sent to it. Messages are displayed in a web interface which
runs at ``http://localhost:8025/`` You need to download the MailHog
executable for your operating system, see the 'Developing Locally' docs
for instructions.
use_sentry_for_error_reporting [n]
Whether to use Sentry_ to log errors from your project.
use_opbeat [n]
Whether to use Opbeat_ for preformance monitoring and code optimization.
use_pycharm [n]
Adds support for developing in PyCharm_ with a preconfigured .idea directory.
windows [n] windows [n]
Whether you'll be developing on Windows. Indicates whether the project should be configured for development on Windows.
use_pycharm [n]
Indicates whether the project should be configured for development with PyCharm_.
use_docker [y] use_docker [y]
Whether to use Docker_, separating the app and database into separate Indicates whether the project should be configured to use Docker_ and `Docker Compose`_.
containers.
use_heroku [n] postgresql_version [1]
Add configuration to deploy the application to a Heroku_ instance. Select a PostgreSQL_ version to use. The choices are:
use_compressor [n] 1. 10.3
Use `Django Compressor`_ to minify and combine rendered JavaScript and CSS 2. 10.2
into cachable static resources. 3. 10.1
4. 9.6
5. 9.5
6. 9.4
7. 9.3
js_task_runner [1] js_task_runner [1]
Select a JavaScript task runner. The choices are: Select a JavaScript task runner. The choices are:
@ -73,41 +65,63 @@ js_task_runner [1]
3. None 3. None
custom_bootstrap_compilation [n] custom_bootstrap_compilation [n]
Scaffold out recompiling Bootstrap as as task, with Gulp_ or Grunt_. Indicates whether the project should support Bootstrap recompilation
Useful for letting you change Bootstrap variables in real time. via the selected JavaScript task runner's task. This can be useful
Consult project README for more details. for real-time Bootstrap variable alteration.
open_source_license [1] use_compressor [n]
Select a software license for the project. The choices are: Indicates whether the project should be configured to use `Django Compressor`_.
1. MIT_ use_celery [n]
2. BSD_ Indicates whether the project should be configured to use Celery_.
3. GPLv3_
4. `Apache Software License 2.0`_ use_mailhog [n]
5. Not open source Indicates whether the project should be configured to use MailHog_.
use_sentry_for_error_reporting [n]
Indicates whether the project should be configured to use Sentry_.
use_opbeat [n]
Indicates whether the project should be configured to use Opbeat_.
use_whitenoise [y]
Indicates whether the project should be configured to use WhiteNoise_.
use_heroku [n]
Indicates whether the project should be configured so as to be deployable
to Heroku_.
use_travisci [n] use_travisci [n]
Generate `Travis CI`_ configuration file. Indicates whether the project should be configured to use `Travis CI`_.
**NOTE:** *If you choose to use Docker, selecting a JavaScript task runner is
not supported out of the box.*
.. _WhiteNoise: https://github.com/evansd/whitenoise
.. _Celery: https://github.com/celery/celery
.. _MailHog: https://github.com/mailhog/MailHog
.. _Sentry: https://github.com/getsentry/sentry
.. _Opbeat: https://github.com/opbeat/opbeat_python
.. _PyCharm: https://www.jetbrains.com/pycharm/
.. _Docker: https://github.com/docker/docker
.. _Heroku: https://github.com/heroku/heroku-buildpack-python
.. _Django Compressor: https://github.com/django-compressor/django-compressor
.. _Gulp: https://github.com/gulpjs/gulp
.. _Grunt: https://github.com/gruntjs/grunt
.. _Webpack: https://github.com/webpack/webpack
.. _Let's Encrypt: https://github.com/certbot/certbot
.. _MIT: https://opensource.org/licenses/MIT .. _MIT: https://opensource.org/licenses/MIT
.. _BSD: https://opensource.org/licenses/BSD-3-Clause .. _BSD: https://opensource.org/licenses/BSD-3-Clause
.. _GPLv3: https://www.gnu.org/licenses/gpl.html .. _GPLv3: https://www.gnu.org/licenses/gpl.html
.. _Apache Software License 2.0: http://www.apache.org/licenses/LICENSE-2.0 .. _Apache Software License 2.0: http://www.apache.org/licenses/LICENSE-2.0
.. _PyCharm: https://www.jetbrains.com/pycharm/
.. _Docker: https://github.com/docker/docker
.. _Docker Compose: https://docs.docker.com/compose/
.. _PostgreSQL: https://www.postgresql.org/docs/
.. _Gulp: https://github.com/gulpjs/gulp
.. _Grunt: https://github.com/gruntjs/grunt
.. _Django Compressor: https://github.com/django-compressor/django-compressor
.. _Celery: https://github.com/celery/celery
.. _MailHog: https://github.com/mailhog/MailHog
.. _Sentry: https://github.com/getsentry/sentry
.. _Opbeat: https://github.com/opbeat/opbeat_python
.. _WhiteNoise: https://github.com/evansd/whitenoise
.. _Heroku: https://github.com/heroku/heroku-buildpack-python
.. _Travis CI: https://travis-ci.org/ .. _Travis CI: https://travis-ci.org/