django-libs 0.3

A collection of things that we re-use in every Django project, such as custom middlewares, testrunner, templates, templatetags, test mixins, test factories etc...

Django Libs
===========

This project aims to provide commonly used building blocks for Django projects
and applications.

__Current features__:

* A custom testrunner that uses django-nose for discovering tests and
django-coverage for automatically generating a coverage report on each test
run
* A factory for creating User objects
* TestCase mixins to ease the process of testing views via ``self.client.get``

__Coming soon__:

* View mixins to make class based views private for authenticated users
* Extensive fabfile for checking pep8 compliancy, running tests, importing
and exporting the database and locale files, dumping and loading fixtures
etc.
* Useful shell scripts to be installed on the server for various maintenance
and deployment tasks
* Templatetag for displaying the currently selected main navigation item
* Custom test_email_backend that sends emails to your own address no matter
who the recepient is
* Smart urlpatterns to serve static and media files when you set DEBUG=False
locally, no need to setup Apache on your development machine
* A set of templates for django-registration and some partials for rendering
forms compatible with Twitter Bootstrap.

Installation
------------

To get the latest stable release from PyPi::

$ pip install django-libs

To get the latest commit from GitHub::

$ pip install -e git://github.com/bitmazk/django-libs.git#egg=django_libs

Usage
-----

See the docs folder for descriptions of the different tools this project
provides.

Or read the docs here: http://django-libs.readthedocs.org/en/latest/

Contribute
----------

If you want to contribute to this project, please perform the following steps::

# Fork this repository
# Clone your fork
$ mkvirtualenv -p python2.7 django-libs
$ pip install -r requirements.txt

$ git co -b feature_branch master
# Implement your feature and tests
$ git add . && git commit
$ git push -u origin feature_branch
# Send us a pull request for your feature branch