https://github.com/jambonrose/django-decorator-plus

Extra decorators for your Django project.
https://github.com/jambonrose/django-decorator-plus

Last synced: 28 days ago
JSON representation

Extra decorators for your Django project.

• Host: GitHub
• URL: https://github.com/jambonrose/django-decorator-plus
• Owner: jambonrose
• License: bsd-2-clause
• Created: 2015-09-02T15:25:04.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2015-09-04T04:19:18.000Z (about 9 years ago)
• Last Synced: 2024-10-05T07:47:54.099Z (about 2 months ago)
• Language: Python
• Size: 191 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
=====================

Django Decorator Plus

=====================

.. image:: http://img.shields.io/pypi/status/django-decorator-plus.svg

    :target: https://pypi.python.org/pypi/django-decorator-plus

.. image:: http://img.shields.io/pypi/v/django-decorator-plus.svg

    :target: https://pypi.python.org/pypi/django-decorator-plus

.. image:: https://img.shields.io/pypi/pyversions/django-decorator-plus.svg

    :target: https://pypi.python.org/pypi/django-decorator-plus

.. image:: https://img.shields.io/badge/Django-1.7%2C%201.8-brightgreen.svg

    :target: https://pypi.python.org/pypi/django-decorator-plus

.. image:: https://readthedocs.org/projects/django-decorator-plus/badge/?version=latest

    :target: https://django-decorator-plus.readthedocs.org

    :alt: Documentation Statu

Description

===========

This package provides decorators to make building websites in Django

even easier.

Installation

============

.. code:: console

    $ pip install django-decorator-plus

Usage

=====

Please see the `Package Documentation`_ for all usage information. The

`PYPI`_ page has a basic demonstration of a few of the more notable

decorators in the package.

Contributing

============

Please fork the project to your own github account, create a new branch

for your feature or fix, and then pull request any changes.

Any changes to the code must be reflected in the documentation.

To run tests, please first install the development copy of the project

in your environment (use of |virtualenvwrapper|_ encouraged). This may

be accomplished with |pip|_.

.. code:: console

    $ # from the project root directory

    $ pip install -r requirements/test_requirements.txt

    $ pip install -e .

Tests may then be run thanks to the ``Makefile``.

.. code:: console

    $ make test

Once local changes pass the test suite, you may use ``tox`` to check the new

code in other environments.

To see all of the environments being currently test, you may use:

.. code:: console

    $ tox -l

To run all of the tests, use:

.. code:: console

    $ tox

To limit the test to a single environment, the ``e`` flag may be passed:

.. code:: console

    $ # tox -e [environment name]

    $ tox -e django18-py34

.. _`Package Documentation`: https://django-decorator-plus.readthedocs.org

.. _`PyPI`: https://pypi.python.org/pypi/django-decorator-plus

.. |pip| replace:: ``pip``

.. _`pip`: https://pypi.python.org/pypi/pip

.. |virtualenvwrapper| replace:: ``virtualenvwrapper``

.. _`virtualenvwrapper`: https://pypi.python.org/pypi/virtualenvwrapper