Metadata-Version: 2.1
Name: unicef-restlib
Version: 0.6.1
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
Description: 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
        
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.2
Classifier: Framework :: Django :: 3.0
Classifier: Framework :: Django :: 3.1
Classifier: Intended Audience :: Developers
Provides-Extra: test
