Metadata-Version: 2.0
Name: signbank-feedback
Version: 0.1.0
Summary: The feedback component of Signbank
Home-page: https://github.com/hujosh/signbank-feedback
Author: Joshua Goddard
Author-email: joshua.goddard@students.mq.edu.au
License: BSD
Keywords: signbank-feedback
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.10
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Requires-Dist: django-model-utils (>=2.0)

=============================
Signbank-Feedback
=============================

.. image:: https://badge.fury.io/py/signbank-feedback.png
    :target: https://badge.fury.io/py/signbank-feedback

.. image:: https://travis-ci.org/hujosh/signbank-feedback.png?branch=master
    :target: https://travis-ci.org/hujosh/signbank-feedback

.. image:: https://codecov.io/gh/hujosh/signbank-feedback/branch/master/graph/badge.svg
  :target: https://codecov.io/gh/hujosh/signbank-feedback

The feedback component of Signbank

Documentation
-------------

The full documentation is at https://signbank-feedback.readthedocs.org.

Quickstart
----------

Install Signbank-Feedback::

    pip install signbank-feedback

Then use it in a project::

    import feedback


You must define the following variables in ``settings.py``:

* ``LANGUAGE_NAME = "Auslan"``
* ``COUNTRY_NAME = "Australia"``
* ``SITE_TITLE = "Signbank"``

That's for the Auslan site. For BSL, or another sign language, 
you would use different values for those three variables.

You must also add ``bootstrap3`` and ``feedback`` to your ``INSTALLED_APPS`` variable.

Features
--------

* TODO

Running Tests
--------------

Does the code actually work?

::

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

Credits
---------

Tools used in rendering this package:

*  Cookiecutter_
*  `cookiecutter-djangopackage`_

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`cookiecutter-djangopackage`: https://github.com/pydanny/cookiecutter-djangopackage




History
-------

0.1.0 (2016-08-29)
++++++++++++++++++

* First release on PyPI.


