Metadata-Version: 2.1
Name: django-start-tool
Version: 1.0.0
Summary: A full-featured CLI for quickly creating django projects.
Home-page: UNKNOWN
Author: Georgy Gnezdilov
Author-email: georgy.gnezdilov@gmail.com
License: MIT
Project-URL: Source, https://github.com/solarless/django-start-tool
Platform: UNKNOWN
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.10
License-File: LICENSE
Requires-Dist: jinja2 (>=3.1.2)
Requires-Dist: markupsafe (>=2.1.1)

###########################
django-start-tool |version|
###########################

.. |version| image:: https://img.shields.io/pypi/v/django-start-tool
    :target: https://pypi.org/project/django-start-tool
    :alt: PyPI

Usage
=====

Detailed usage information can be found by typing ``django-start --help``

Examples
========

Create default project:

.. code-block:: shell

    $ django-start

    # Is equivalent to

    $ django-admin startproject config .

Create project from template:

.. code-block:: shell

    $ django-start \
    > -t /path/to/template

    # Is equivalent to

    $ django-admin startproject \
    > --template /path/to/template

.. code-block:: shell

    $ django-start \
    > -t https://github.com/<user>/<repository>/archive/main.zip

    # Is equivalent to

    $ django-admin startproject \
    > --template https://github.com/<user>/<repository>/archive/main.zip

Add files to rendering (in addition to ``*-tpl``):

.. code-block:: shell

    $ django-start \
    > -t /path/to/template \
    > -r '*.env Procfile'

    # Is equivalent to

    $ django-admin startproject \
    > --template /path/to/template \
    > --extension env \
    > --name Procfile

Exclude directories from rendering (in addition to ``.git`` and ``__pycache__``):

.. code-block:: shell

    $ django-start \
    > -t /path/to/template \
    > -x 'data logs'

    # Is equivalent to

    $ django-admin startproject \
    > --template /path/to/template \
    > --exclude data,logs


