open-api-framework 0.1.0__tar.gz → 0.3.0__tar.gz

open_api_framework-0.3.0/CHANGELOG.rst

@@ -0,0 +1,26 @@
+Changelog
+=========
+
+0.3.0 (2024-05-17)
+------------------
+
+**New features**
+
+* [#14] Add django-log-outgoing-requests to deps
+* [open-zaak/open-zaak#1629] Add generic base settings file
+
+
+0.2.0 (2024-03-22)
+------------------
+
+**New features**
+
+* Add support for python 3.10
+* Upgrade to Django 4.2
+* Add maykin-2fa
+
+
+0.1.0 (2024-01-30)
+------------------
+
+* Initial release as a metapackage to pin several dependencies

{open_api_framework-0.1.0/open_api_framework.egg-info → open_api_framework-0.3.0}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: open_api_framework
-Version: 0.1.0
-Summary: TODO
+Version: 0.3.0
+Summary: A metapackage for registration components, that bundles the dependencies shared between these components and provides generic settings
 Author-email: Maykin Media <support@maykinmedia.nl>
 License: Copyright 2024 Maykin Media
         
@@ -15,10 +15,9 @@ 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
+Keywords: metapackage,dependencies,settings
 Classifier: Development Status :: 3 - Alpha
 Classifier: Framework :: Django
-Classifier: Framework :: Django :: 3.2
 Classifier: Framework :: Django :: 4.2
 Classifier: Intended Audience :: Developers
 Classifier: Operating System :: Unix
@@ -31,11 +30,12 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.9
 Description-Content-Type: text/x-rst
 License-File: LICENSE
-Requires-Dist: django>=3.2.23
+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-log-outgoing-requests>=0.6.1
 Requires-Dist: django-admin-index>=3.1.0
 Requires-Dist: django-redis>=5.4.0
 Requires-Dist: djangorestframework>=3.12.4
@@ -56,6 +56,7 @@ 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: tests
 Requires-Dist: pytest; extra == "tests"
 Requires-Dist: pytest-django; extra == "tests"
@@ -74,19 +75,18 @@ Requires-Dist: twine; extra == "release"
 
 
 
-Welcome to open_api_framework's documentation!
+Welcome to open-api-framework's documentation!
 =================================================
 
-:Version: 0.1.0
-:Source: https://github.com/maykinmedia/open_api_framework
-:Keywords: ``<keywords>``
-:PythonVersion: 3.11
+:Version: 0.3.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|
 
-<One liner describing the project>
+A metapackage for registration components, that bundles the dependencies shared between these components
 
 .. contents::
 
@@ -95,8 +95,7 @@ Welcome to open_api_framework's documentation!
 Features
 ========
 
-* ...
-* ...
+* Bundling shared dependencies and introducing minimum versions for these dependencies
 
 Installation
 ============
@@ -104,27 +103,21 @@ Installation
 Requirements
 ------------
 
-* Python 3.9/3.11 or above
-* Django 3.2/4.2 or newer
+* Python 3.9 or above
+* Django 4.2 or newer
 
 
 Install
 -------
 
-.. code-block:: bash
-
-    pip install open_api_framework
-
-
-Usage
-=====
-
-<document or refer to docs>
+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::
+To install and develop the library locally, use:
 
 .. code-block:: bash
 
@@ -141,28 +134,28 @@ directory to the python path (or use ``python -m django <command>``):
     # django-admin makemessages -l nl
 
 
-.. |build-status| image:: https://github.com/maykinmedia/open_api_framework/workflows/Run%20CI/badge.svg
+.. |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
+    :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
+.. |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
+     :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
+.. |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
+.. |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
+.. |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
+.. |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/
+.. |pypi-version| image:: https://img.shields.io/pypi/v/open-api-framework.svg
+    :target: https://pypi.org/project/open-api-framework/

open_api_framework-0.3.0/README.rst

@@ -0,0 +1,86 @@
+
+
+Welcome to open-api-framework's documentation!
+=================================================
+
+:Version: 0.3.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/