Metadata-Version: 2.1
Name: open_api_framework
Version: 0.2.0
Summary: TODO
Author-email: Maykin Media <support@maykinmedia.nl>
License: Copyright 2024 Maykin Media
        
        Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
        
Project-URL: Homepage, https://github.com/maykinmedia/open_api_framework
Project-URL: Documentation, http://open_api_framework.readthedocs.io/en/latest/
Project-URL: Bug Tracker, https://github.com/maykinmedia/open_api_framework/issues
Project-URL: Source Code, https://github.com/maykinmedia/open_api_framework
Keywords: TODO
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Django
Classifier: Framework :: Django :: 4.2
Classifier: Intended Audience :: Developers
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.9
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: django >=4.2.11
Requires-Dist: django-axes >=6.3.0
Requires-Dist: django-cors-headers >=4.3.1
Requires-Dist: django-markup >=1.8.1
Requires-Dist: django-jsonform >=2.21.4
Requires-Dist: django-admin-index >=3.1.0
Requires-Dist: django-redis >=5.4.0
Requires-Dist: djangorestframework >=3.12.4
Requires-Dist: djangorestframework-gis >=1.0
Requires-Dist: django-filter >=23.2
Requires-Dist: drf-spectacular >=0.27.0
Requires-Dist: djangorestframework-inclusions >=1.2.0
Requires-Dist: commonground-api-common >=1.12.1
Requires-Dist: mozilla-django-oidc-db >=0.14.1
Requires-Dist: zgw-consumers >=0.27.0
Requires-Dist: psycopg2 >=2.9.9
Requires-Dist: bleach >=6.1.0
Requires-Dist: python-dotenv >=1.0.0
Requires-Dist: python-decouple >=3.8
Requires-Dist: requests >=2.31.0
Requires-Dist: uwsgi >=2.0.23
Requires-Dist: sentry-sdk >=1.39.2
Requires-Dist: elastic-apm >=6.20.0
Requires-Dist: celery >=5.2.7
Requires-Dist: flower >=2.0.1
Requires-Dist: maykin-2fa >=1.0.0
Provides-Extra: coverage
Requires-Dist: pytest-cov ; extra == 'coverage'
Provides-Extra: docs
Requires-Dist: sphinx ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme ; extra == 'docs'
Provides-Extra: release
Requires-Dist: bump-my-version ; extra == 'release'
Requires-Dist: twine ; extra == 'release'
Provides-Extra: tests
Requires-Dist: pytest ; extra == 'tests'
Requires-Dist: pytest-django ; extra == 'tests'
Requires-Dist: tox ; extra == 'tests'
Requires-Dist: isort ; extra == 'tests'
Requires-Dist: black ; extra == 'tests'
Requires-Dist: flake8 ; extra == 'tests'



Welcome to open-api-framework's documentation!
=================================================

:Version: 0.2.0
:Source: https://github.com/maykinmedia/open-api-framework
:Keywords: metapackage, dependencies

|build-status| |code-quality| |black| |coverage| |docs|

|python-versions| |django-versions| |pypi-version|

A metapackage for registration components, that bundles the dependencies shared between these components

.. contents::

.. section-numbering::

Features
========

* Bundling shared dependencies and introducing minimum versions for these dependencies

Installation
============

Requirements
------------

* Python 3.9 or above
* Django 4.2 or newer


Install
-------

1. Add open-api-framework to your requirements file
2. Remove dependencies from your requirements file that occur in ``pyproject.toml``
3. Recompile the dependencies

Local development
=================

To install and develop the library locally, use::

.. code-block:: bash

    pip install -e .[tests,coverage,docs,release]

When running management commands via ``django-admin``, make sure to add the root
directory to the python path (or use ``python -m django <command>``):

.. code-block:: bash

    export PYTHONPATH=. DJANGO_SETTINGS_MODULE=testapp.settings
    django-admin check
    # or other commands like:
    # django-admin makemessages -l nl


.. |build-status| image:: https://github.com/maykinmedia/open-api-framework/workflows/Run%20CI/badge.svg
    :alt: Build status
    :target: https://github.com/maykinmedia/open-api-framework/actions?query=workflow%3A%22Run+CI%22

.. |code-quality| image:: https://github.com/maykinmedia/open-api-framework/workflows/Code%20quality%20checks/badge.svg
     :alt: Code quality checks
     :target: https://github.com/maykinmedia/open-api-framework/actions?query=workflow%3A%22Code+quality+checks%22

.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black

.. |coverage| image:: https://codecov.io/gh/maykinmedia/open-api-framework/branch/main/graph/badge.svg
    :target: https://codecov.io/gh/maykinmedia/open-api-framework
    :alt: Coverage status

.. |docs| image:: https://readthedocs.org/projects/open-api-framework/badge/?version=latest
    :target: https://open-api-framework.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status

.. |python-versions| image:: https://img.shields.io/pypi/pyversions/open-api-framework.svg

.. |django-versions| image:: https://img.shields.io/pypi/djversions/open-api-framework.svg

.. |pypi-version| image:: https://img.shields.io/pypi/v/open-api-framework.svg
    :target: https://pypi.org/project/open-api-framework/
