Metadata-Version: 2.1
Name: unicef-security
Version: 1.6.3
Summary: Provides Basic UNICEF User model and integration with Azure
Author-Email: UNICEF <rapidpro@unicef.org>
License: Apache-2.0 OR MIT
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 3.2
Classifier: Framework :: Django :: 4.2
Classifier: Framework :: Django :: 5.0
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Project-URL: Homepage, https://github.com/unicef/unicef-security
Requires-Dist: celery
Requires-Dist: cryptography
Requires-Dist: django
Requires-Dist: django-admin-extra-buttons
Requires-Dist: django-constance
Requires-Dist: django-countries
Requires-Dist: django-picklefield
Requires-Dist: PyJWT
Requires-Dist: requests
Requires-Dist: social-auth-app-django
Requires-Dist: setuptools
Requires-Dist: wheel
Provides-Extra: test
Requires-Dist: django-webtest; extra == "test"
Requires-Dist: factory-boy; extra == "test"
Requires-Dist: flake8; extra == "test"
Requires-Dist: httpretty; extra == "test"
Requires-Dist: isort; extra == "test"
Requires-Dist: mock; 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: requests-mock; extra == "test"
Requires-Dist: unittest2; extra == "test"
Requires-Dist: vcrpy; extra == "test"
Description-Content-Type: text/x-rst

UNICEF-Security
===============


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

.. code-block:: bash

    pip install unicef-security


Setup
-----

Add ``unicef_security`` to ``INSTALLED_APPS`` in settings

.. code-block:: bash

    INSTALLED_APPS = [
        'admin_extra_urls',
        'unicef_security',
    ]


Usage
-----

TODO

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

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

To configure the development environment

.. code-block:: bash

    $ make develop


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;



Links
~~~~~

+--------------------+----------------+--------------+--------------------+
| Stable             | |master-build| | |master-cov| |                    |
+--------------------+----------------+--------------+--------------------+
| Development        | |dev-build|    | |dev-cov|    |                    |
+--------------------+----------------+--------------+--------------------+
| Source Code        |https://github.com/unicef/unicef-security           |
+--------------------+----------------+-----------------------------------+
| Issue tracker      |https://github.com/unicef/unicef-security/issues    |
+--------------------+----------------+-----------------------------------+


.. |master-build| image:: https://secure.travis-ci.org/unicef/unicef-security.svg?branch=master
                    :target: http://travis-ci.org/unicef/unicef-security/

.. |master-cov| image:: https://codecov.io/gh/unicef/unicef-security/branch/master/graph/badge.svg
                    :target: https://codecov.io/gh/unicef/unicef-security

.. |dev-build| image:: https://secure.travis-ci.org/unicef/unicef-security.svg?branch=develop
                  :target: http://travis-ci.org/unicef/unicef-security/

.. |dev-cov| image:: https://codecov.io/gh/unicef/unicef-security/branch/develop/graph/badge.svg
                    :target: https://codecov.io/gh/unicef/unicef-security



Compatibility Matrix
--------------------

Stable
~~~~~~

.. image:: https://travis-matrix-badges.herokuapp.com/repos/unicef/unicef-security/branches/master


Develop
~~~~~~~

.. image:: https://travis-matrix-badges.herokuapp.com/repos/unicef/unicef-security/branches/develop
