/pyscaffoldext-django

:horse: PyScaffold extension that calls on `django-admin` on project creation

Primary LanguagePythonMIT LicenseMIT

Travis ReadTheDocs Coveralls PyPI-Server

pyscaffoldext-django

Integration of Django's built-in generator (django-admin) into PyScaffold

PyScaffold is a development tool focused in distributable Python packages. This extension allows the development of Django websites using PyScaffold sensible project structure, by tapping into the django-admin cli.

Quickstart

This extension can be directly installed with pip:

$ pip install pyscaffoldext-django

Or, if you prefer pipx:

$ pipx install pyscaffold  # if you haven't installed pyscaffold yet
$ pipx inject pyscaffold pyscaffoldext-django

Note that, after the installation, putup -h will show a new option --django. Use this option to indicate when you are trying to create a django app. For example:

$ putup --django myapp

Please refer to django-admin documentation for more details.

Note

Using Django extension in PyScaffold is roughly equivalent to first create an app using django-admin and then convert it to PyScaffold:

$ django-admin startproject myapp
$ mkdir myapp/src
$ mv myapp/myapp myapp/src
$ putup myapp --force

For complex use cases, maybe a better option is to do the conversion manually.

Note

This project has been set up using PyScaffold 3.2. For details and usage information on PyScaffold see https://pyscaffold.org/.