<commit_before>Cookiecutter Django Basic App
=============================

A cookiecutter template to create a Django app within an existing Django project, with boilerplate including:
    * A barebones Django model.
    * Django CRUD views and templates using Django's Class Based Views.
    * Django form templates that output `Bootstrap <http://getbootstrap.com/>`_ HTML using `django-bootstrap-form <https://github.com/tzangms/django-bootstrap-form>`_.
    * Tests for all of the views.
    * Model instances generated using `factory boy <https://github.com/rbarrois/factory_boy>`_ for the tests.

Quickstart
==========

1. Install cookiecutter, and apps listed in requirements.txt for our generated app.  Install them all with:

.. code-block:: console

    pip install -r https://raw.github.com/epicserve/cookiecutter-django-basic-app/master/requirements.txt


2. Run cookiecutter using this template.  Note that **it will overwrite existing files without warning if you already have an app dir of the same name**, so make sure your code is checked in or backed up.

.. code-block:: console

    cookiecutter git<EMAIL>:epicserve/cookiecutter-django-basic-app.git
<commit_msg>Readme tweaks<commit_after>Cookiecutter Django Basic App
=============================

A cookiecutter template to create a Django app within an existing Django project, with a boilerplate that includes:
    * A barebones Django model.
    * Django CRUD views and templates using Django's Class Based Views.
    * Django form templates that output `Bootstrap <http://getbootstrap.com/>`_ HTML using `django-bootstrap-form <https://github.com/tzangms/django-bootstrap-form>`_.
    * Tests for all of the views.
    * Model instances generated using `factory boy <https://github.com/rbarrois/factory_boy>`_ for the tests.

Quickstart
==========

1. Install `cookiecutter <https://github.com/audreyr/cookiecutter>`_, and the apps listed in requirements.txt.  Install them all with:

.. code-block:: console

    pip install -r https://raw.github.com/epicserve/cookiecutter-django-basic-app/master/requirements.txt


2. Run cookiecutter using this template.  Note that **it will overwrite existing files without warning if you already have an app dir of the same name**, so make sure your code is checked in or backed up.

.. code-block:: console

    cookiecutter <EMAIL>:epicserve/cookiecutter-django-basic-app.git

{'fraction_non_alphanumeric': 0.11519198664440734, 'fraction_numerical': 0.001669449081803005, 'mean_word_length': 4.222222222222222, 'pattern_counts': {'":': 0, '<': 12, '<?xml version=': 0, '>': 12, 'https://': 7, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1810642', 'n_tokens_mistral': 677, 'n_tokens_neox': 635, 'n_words': 251}