<commit_before>Django Packagemaker
===================

django-packagemaker is aimed at making it much easier to quickly scaffold
a python package for a django reusable app. It tries to find a balance between
respecting individual choices and being opinionated enough to be useful.

To this end it is more than just a paster template of Django's startapp output.
It creates things like an admin.py file, docs with sphinx-quickstart pre-run
etc.

Getting started
---------------

Install django-packagemaker with pip::

    $ pip install django-packagemaker

This will also install the dependencies for using the paster command

Note if you are using virtualenv (and you should be) that due to some
limitation of paste script, the paster packages must be installed in the same
virtualenv as django-packagemaker. If you are using pip's cache (and you should
be) this isn't too bad a speed hit on your virtualenv buildout.

That means if you have paste script already installed in your system
site-packages, you are likely to run into some troubles.

After installation, you can run::

    $ paster create -t app_package coolapp

This will prompt you for several pieces of information about your package, hit
return to accept the defaults. If you have git configured, it will attempt to
read your git config for your name and email. The result will be a directory
with this layout::

    coolapp
    coolapp/coolapp
    coolapp/coolapp/__init__.py
    coolapp/coolapp/admin.py
    coolapp/coolapp/forms.py<commit_msg>noted absence of this project on pypi in readme<commit_after>Django Packagemaker
===================

django-packagemaker is aimed at making it much easier to quickly scaffold
a python package for a django reusable app. It tries to find a balance between
respecting individual choices and being opinionated enough to be useful.

To this end it is more than just a paster template of Django's startapp output.
It creates things like an admin.py file, docs with sphinx-quickstart pre-run
etc.

Getting started
---------------

Install django-packagemaker with pip::

    $ pip install git+git://github.com/ptone/django-packagemaker.git#egg=django_paster

[NOTE: For now, this project itself is not yet on PyPi until more stable]

This will also install the dependencies for using the paster command

Note if you are using virtualenv (and you should be) that due to some
limitation of paste script, the paster packages must be installed in the same
virtualenv as django-packagemaker. If you are using pip's cache (and you should
be) this isn't too bad a speed hit on your virtualenv buildout.

That means if you have paste script already installed in your system
site-packages, you are likely to run into some troubles.

After installation, you can run::

    $ paster create -t app_package coolapp

This will prompt you for several pieces of information about your package, hit
return to accept the defaults. If you have git configured, it will attempt to
read your git config for your name and email. The result will be a directory
with this layout::

    coolapp
    coolapp/coolapp
    coolapp/coolapp/__init__.py
    coolapp/coolapp/admin.py
    coolapp/coolapp/forms.py
{'fraction_non_alphanumeric': 0.0583804143126177, 'fraction_numerical': 0.0, 'mean_word_length': 4.011006289308176, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, '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': '1135208', 'n_tokens_mistral': 842, 'n_tokens_neox': 802, 'n_words': 455}