Metadata-Version: 2.4
Name: hope-api-auth
Version: 0.1
Summary: Provides API Authentication and Authorization within HOPE Ecosystem
Project-URL: Homepage, https://github.com/unicef/hope-api-auth
Author-email: UNICEF <rapidpro@unicef.org>
License-Expression: Apache-2.0 OR MIT
License-File: LICENSE
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 5.2
Classifier: Framework :: Django :: 6.0
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: django
Requires-Dist: django-admin-extra-buttons
Requires-Dist: django-adminfilters
Requires-Dist: django-smart-admin
Requires-Dist: djangorestframework
Requires-Dist: psycopg2-binary
Requires-Dist: swapper
Description-Content-Type: text/markdown

HOPE-API-AUTH
=============

| Menu               | Badge / Link                                                                                                                                      |
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| Coverage Development | [![codecov](https://codecov.io/gh/unicef/hope-api-auth/branch/main/graph/badge.svg?token=sytM1cd8Zj)](https://codecov.io/gh/unicef/hope-api-auth) |
| Coverage Stable      | [![codecov](https://codecov.io/gh/unicef/hope-api-auth/branch/main/graph/badge.svg?token=sytM1cd8Zj)](https://codecov.io/gh/unicef/hope-api-auth) |
| Issue Tracker        | [GitHub Issues](https://github.com/unicef/hope-api-auth/issues)                                                                                   |

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

    pip install hope-api-auth


Setup
-----

Add ``hope_api_auth`` to ``INSTALLED_APPS`` in settings

    INSTALLED_APPS = [
        'hope_api_auth',
    ]


Coding Standards
----------------

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

    $ ruff check
    $ ruff format


Testing
-------

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

    $ uv run pytest tests

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