Django Powerbank¶

Extra power for included batteries

Free software: MIT license
Documentation: https://django-powerbank.readthedocs.io.

Work in progress¶

This package was created with wooyek/cookiecutter-django-app project template. It may fool you by having a lot of cookie filling just ready from the start. Be warned! It may not be ready for eating!

https://media.giphy.com/media/DmLUhoNUBfz5C/giphy.gif

Features¶

Pending :D

Demo¶

To run an example project for this django reusable app, click the button below and start a demo serwer on Heroku

Deploy Django Opt-out example project to Heroku

Quickstart¶

Install Django Powerbank:

pip install django-powerbank

Add it to your INSTALLED_APPS:

INSTALLED_APPS = (
    ...
    'django_powerbank.apps.DjangoPowerbankConfig',
    ...
)

Add Django Powerbank’s URL patterns:

from django_powerbank import urls as django_powerbank_urls


urlpatterns = [
    ...
    url(r'^', include(django_powerbank_urls)),
    ...
]

Running Tests¶

Does the code actually work?

$ pipenv install --dev
$ pipenv shell
$ tox

We recommend using pipenv but a legacy approach to creating virtualenv and installing requirements should also work. Please install requirements/development.txt to setup virtual env for testing and development.

Credits¶

This package was created with Cookiecutter and the wooyek/cookiecutter-django-app project template.