Metadata-Version: 2.1
Name: unicef-restlib
Version: 0.5
Summary: Django package that handles exporting of data
Home-page: https://github.com/unicef/unicef-rest-export
Author: UNICEF
Author-email: dev@unicef.org
License: Apache 2 License
Platform: any
Classifier: Environment :: Web Environment
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Framework :: Django
Classifier: Framework :: Django :: 2.1
Classifier: Framework :: Django :: 2.2
Classifier: Intended Audience :: Developers
Requires-Dist: django
Requires-Dist: django-fsm
Requires-Dist: djangorestframework
Requires-Dist: djangorestframework-recursive
Requires-Dist: drf-nested-routers
Requires-Dist: unicef-djangolib
Provides-Extra: test
Requires-Dist: coverage ; extra == 'test'
Requires-Dist: django-fsm ; extra == 'test'
Requires-Dist: factory-boy ; extra == 'test'
Requires-Dist: faker ; extra == 'test'
Requires-Dist: flake8 ; extra == 'test'
Requires-Dist: isort ; extra == 'test'
Requires-Dist: pyflakes ; extra == 'test'
Requires-Dist: pytest ; extra == 'test'
Requires-Dist: pytest-cov ; extra == 'test'
Requires-Dist: pytest-django ; extra == 'test'
Requires-Dist: pytest-echo ; extra == 'test'
Requires-Dist: pytest-pythonpath ; extra == 'test'

UNICEF Rest Extra
=================

Django package that handles includes rest framework extras


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

.. code-block:: bash

    pip install unicef-restlib


Setup
-----

Add ``unicef_restlib`` to ``INSTALLED_APPS`` in settings

.. code-block:: bash

    INSTALLED_APPS = [
        ...
        'unicef_restlib',
    ]


Usage
-----

TODO

Contributing
------------

Environment Setup
~~~~~~~~~~~~~~~~~

To install the necessary libraries

.. code-block:: bash

    $ make install


Coding Standards
~~~~~~~~~~~~~~~~

See `PEP 8 Style Guide for Python Code <https://www.python.org/dev/peps/pep-0008/>`_ for complete details on the coding standards.

To run checks on the code to ensure code is in compliance

.. code-block:: bash

    $ make lint


Testing
~~~~~~~

Testing is important and tests are located in `tests/` directory and can be run with;

.. code-block:: bash

    $ make test

Coverage report is viewable in `build/coverage` directory, and can be generated with;


Project Links
~~~~~~~~~~~~~

 - Continuous Integration - https://circleci.com/gh/unicef/unicef-restlib/tree/develop
 - Source Code - https://github.com/unicef/unicef-restlib


