Welcome to django-app-gen’s documentation!

Contents:

django-app-gen

Generate CRUD views, templates, forms, URLs, and tests for a model. For Django 1.8+ and Python 2.7/3.3+.

Documentation

The full documentation is at https://django-app-gen.readthedocs.org.

Quickstart

Install django-app-gen:

pip install django-app-gen

Create a model in your app’s models.py file:

from django.db import models


class Question(models.Model):
    question_text = models.CharField(max_length=200)
    pub_date = models.DateTimeField('date published')

Then generate your views, templates, forms, URLs, and tests.:

python manage.py generate_all Question

Add the new URLs to your root urls.py file. The generated templates and views.py files assume your URLs are namespaced by your app’s name:

urlpatterns = [
    # ...
    url(r"^app_name", include("app_name.urls", namespace="app_name")),
    # ...
]

Running Tests

Does the code actually work?

source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install -r requirements-text.txt
(myenv) $ python runtests.py

Credits

Tools used in rendering this package:

• Cookiecutter
• cookiecutter-pypackage

Installation

At the command line:

$ easy_install django-app-gen

Or, if you have virtualenvwrapper installed:

$ mkvirtualenv django-app-gen
$ pip install django-app-gen

Usage

To use django-app-gen in a project:

import appgen

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/grantmcconnaughey/django-app-gen/issues.

If you are reporting a bug, please include:

• Your operating system name and version.
• Any details about your local setup that might be helpful in troubleshooting.
• Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.

Write Documentation

django-app-gen could always use more documentation, whether as part of the official django-app-gen docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/grantmcconnaughey/django-app-gen/issues.

If you are proposing a feature:

• Explain in detail how it would work.
• Keep the scope as narrow as possible, to make it easier to implement.
• Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up django-app-gen for local development.

1. Fork the django-app-gen repo on GitHub.

2. Clone your fork locally:

   $ git clone git@github.com:your_name_here/django-app-gen.git
   

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

   $ mkvirtualenv django-app-gen
   $ cd django-app-gen/
   $ python setup.py develop
   

4. Create a branch for local development:

   $ git checkout -b name-of-your-bugfix-or-feature
   

Now you can make your changes locally.

5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

$ flake8 appgen tests
$ python setup.py test
$ tox

To get flake8 and tox, just pip install them into your virtualenv.

6. Commit your changes and push your branch to GitHub:

   $ git add .
   $ git commit -m "Your detailed description of your changes."
   $ git push origin name-of-your-bugfix-or-feature
   

7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
3. The pull request should work for Python 2.7 and 3.4+, and for PyPy. Check https://travis-ci.org/grantmcconnaughey/django-app-gen/pull_requests and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

$ python -m unittest tests.test_appgen

Credits

Development Lead

• Grant McConnaughey <grantmcconnaughey@gmail.com>

Contributors

None yet. Why not be the first?

History

0.1.0 (Not released)

• Initial release.