A Django & Project Template to integrate Django, Buildout, Pylint, JSHint, Sphinx etc. Its a work in progress and expected to evolve further. The motivation to do this came from using Maven for Java projects.

1. git clone this repository.
2. Run python bootstrap.py.
3. Edit project-name in buildout.cfg to your project name.
4. Set name in setup.py to the project name too. Add any python dependencies in install_requires.
5. Run bin/buildout
6. Create Django Project bin/buildout install start-django-project
7. Create base Fabfile bin/buildout install fab-template
8. Run bin/fab -l for a list of common supported commands.
9. You would want to add fabfile.py and src/<your-project> to source control.
10. (Optional-elasticbeanstalk) If you want to add elasticbeanstalk configuration, run bin/buildout install elasticbeanstalk-config
11. (Optional-elasticbeanstalk)You also need to change the bucket_name, application_name, enviornment_name in the fabfile.py

The above steps would be needed one time for setting up a new project and generating the project structure. Once done, subsequent builds on new machines are just standard buildout builds i.e.

    python bootstrap.py
    bin/buildout

There are a couple of sample tests in tests/unit and tests/integration folders that should run correctly on invoking the following commands.

$ bin/fab test_integration
> ----------------------------------------------------------------------
> Ran 1 test in 0.008s
>
> OK

$ bin/fab test_unit
> ----------------------------------------------------------------------
> Ran 2 tests in 0.001s
> 
> OK

    check             Runs all checks. Report in out/summary.html. Useful for CI.
    coverage          Enables Coverage. Used for test targets
    docs_gen          Generates Documents. Picks sources from docs folder.
    lint_js           Reports Pylint Errors & Warnings for Python files
    lint_py           Reports Pylint Errors & Warnings for Python files
    runserver         Runs Django Server on port 8000
    test_all          Runs All Tests in src and tests folders
    test_integration  Runs All Tests in tests/integration package
    test_unit         Runs All Tests in tests/unit package
    uml_gen           Generates Package Dependency Diagrams. Assumes Graphviz.

    create_new_version         Beanstalk - Creates a build for the provided version
    deploy_to_dev_environment  Beanstalk - Deploys to Dev Environment

Note: Whenever running a command always prefix it with bin or else your system wide installation would be used. Note: For running tests along with coverage, use bin/fab coverage test_unit etc.

Runtime project dependencies should be added in setup.py. That is the standard python way. However, buildout.cfg also has multiple parts and dependencies installed using recipe = zc.recipe.egg. Build or Test only dependencies can be add here.

Keep the following setting in default buildout config at ~/.buildout/default.cfg. Its a common buildout tip to keep download times low and builds faster.

[buildout]
eggs-directory = <HOME-DIR>/.buildout/eggs
download-cache = <HOME-DIR>/.buildout/dlcache

buildout.cfg is the config to install eggs and generate scripts in bin folder.
fabfile.py contains fabric tasks. You can modify it to add your own.
etc/lint.rc contains pylint configuration.
etc/jshint.json contains jshint settings.
tests contains tests organized in unit, integration and ui packages.

Each of the above can be modified and customized as much as you want. If you implement something generally useful, please contribute it back.

Contributions and ideas are welcome. These are some ideas we would like to implement.

1. test_js target to run javascript tests using a node js framework like mocha etc.
2. django-pipeline for static assets management.
3. build for jenkins build and package
4. incr for linting or testing incremental changes e.g. modified files only.
5. more ...