open-api-framework 0.1.0__tar.gz → 0.2.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {open_api_framework-0.1.0/open_api_framework.egg-info → open_api_framework-0.2.0}/PKG-INFO +26 -34
- open_api_framework-0.2.0/README.rst +86 -0
- {open_api_framework-0.1.0 → open_api_framework-0.2.0/open_api_framework.egg-info}/PKG-INFO +26 -34
- {open_api_framework-0.1.0 → open_api_framework-0.2.0}/open_api_framework.egg-info/requires.txt +2 -1
- {open_api_framework-0.1.0 → open_api_framework-0.2.0}/pyproject.toml +4 -4
- open_api_framework-0.1.0/README.rst +0 -94
- {open_api_framework-0.1.0 → open_api_framework-0.2.0}/LICENSE +0 -0
- {open_api_framework-0.1.0 → open_api_framework-0.2.0}/MANIFEST.in +0 -0
- {open_api_framework-0.1.0 → open_api_framework-0.2.0}/open_api_framework/__init__.py +0 -0
- {open_api_framework-0.1.0 → open_api_framework-0.2.0}/open_api_framework/apps.py +0 -0
- {open_api_framework-0.1.0 → open_api_framework-0.2.0}/open_api_framework/py.typed +0 -0
- {open_api_framework-0.1.0 → open_api_framework-0.2.0}/open_api_framework.egg-info/SOURCES.txt +0 -0
- {open_api_framework-0.1.0 → open_api_framework-0.2.0}/open_api_framework.egg-info/dependency_links.txt +0 -0
- {open_api_framework-0.1.0 → open_api_framework-0.2.0}/open_api_framework.egg-info/top_level.txt +0 -0
- {open_api_framework-0.1.0 → open_api_framework-0.2.0}/setup.cfg +0 -0
- {open_api_framework-0.1.0 → open_api_framework-0.2.0}/tests/test_dummy.py +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.1
|
|
2
2
|
Name: open_api_framework
|
|
3
|
-
Version: 0.
|
|
3
|
+
Version: 0.2.0
|
|
4
4
|
Summary: TODO
|
|
5
5
|
Author-email: Maykin Media <support@maykinmedia.nl>
|
|
6
6
|
License: Copyright 2024 Maykin Media
|
|
@@ -18,7 +18,6 @@ Project-URL: Source Code, https://github.com/maykinmedia/open_api_framework
|
|
|
18
18
|
Keywords: TODO
|
|
19
19
|
Classifier: Development Status :: 3 - Alpha
|
|
20
20
|
Classifier: Framework :: Django
|
|
21
|
-
Classifier: Framework :: Django :: 3.2
|
|
22
21
|
Classifier: Framework :: Django :: 4.2
|
|
23
22
|
Classifier: Intended Audience :: Developers
|
|
24
23
|
Classifier: Operating System :: Unix
|
|
@@ -31,7 +30,7 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
|
31
30
|
Requires-Python: >=3.9
|
|
32
31
|
Description-Content-Type: text/x-rst
|
|
33
32
|
License-File: LICENSE
|
|
34
|
-
Requires-Dist: django>=
|
|
33
|
+
Requires-Dist: django>=4.2.11
|
|
35
34
|
Requires-Dist: django-axes>=6.3.0
|
|
36
35
|
Requires-Dist: django-cors-headers>=4.3.1
|
|
37
36
|
Requires-Dist: django-markup>=1.8.1
|
|
@@ -56,6 +55,7 @@ Requires-Dist: sentry-sdk>=1.39.2
|
|
|
56
55
|
Requires-Dist: elastic-apm>=6.20.0
|
|
57
56
|
Requires-Dist: celery>=5.2.7
|
|
58
57
|
Requires-Dist: flower>=2.0.1
|
|
58
|
+
Requires-Dist: maykin-2fa>=1.0.0
|
|
59
59
|
Provides-Extra: tests
|
|
60
60
|
Requires-Dist: pytest; extra == "tests"
|
|
61
61
|
Requires-Dist: pytest-django; extra == "tests"
|
|
@@ -74,19 +74,18 @@ Requires-Dist: twine; extra == "release"
|
|
|
74
74
|
|
|
75
75
|
|
|
76
76
|
|
|
77
|
-
Welcome to
|
|
77
|
+
Welcome to open-api-framework's documentation!
|
|
78
78
|
=================================================
|
|
79
79
|
|
|
80
|
-
:Version: 0.
|
|
81
|
-
:Source: https://github.com/maykinmedia/
|
|
82
|
-
:Keywords:
|
|
83
|
-
:PythonVersion: 3.11
|
|
80
|
+
:Version: 0.2.0
|
|
81
|
+
:Source: https://github.com/maykinmedia/open-api-framework
|
|
82
|
+
:Keywords: metapackage, dependencies
|
|
84
83
|
|
|
85
84
|
|build-status| |code-quality| |black| |coverage| |docs|
|
|
86
85
|
|
|
87
86
|
|python-versions| |django-versions| |pypi-version|
|
|
88
87
|
|
|
89
|
-
|
|
88
|
+
A metapackage for registration components, that bundles the dependencies shared between these components
|
|
90
89
|
|
|
91
90
|
.. contents::
|
|
92
91
|
|
|
@@ -95,8 +94,7 @@ Welcome to open_api_framework's documentation!
|
|
|
95
94
|
Features
|
|
96
95
|
========
|
|
97
96
|
|
|
98
|
-
*
|
|
99
|
-
* ...
|
|
97
|
+
* Bundling shared dependencies and introducing minimum versions for these dependencies
|
|
100
98
|
|
|
101
99
|
Installation
|
|
102
100
|
============
|
|
@@ -104,22 +102,16 @@ Installation
|
|
|
104
102
|
Requirements
|
|
105
103
|
------------
|
|
106
104
|
|
|
107
|
-
* Python 3.9
|
|
108
|
-
* Django
|
|
105
|
+
* Python 3.9 or above
|
|
106
|
+
* Django 4.2 or newer
|
|
109
107
|
|
|
110
108
|
|
|
111
109
|
Install
|
|
112
110
|
-------
|
|
113
111
|
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
Usage
|
|
120
|
-
=====
|
|
121
|
-
|
|
122
|
-
<document or refer to docs>
|
|
112
|
+
1. Add open-api-framework to your requirements file
|
|
113
|
+
2. Remove dependencies from your requirements file that occur in ``pyproject.toml``
|
|
114
|
+
3. Recompile the dependencies
|
|
123
115
|
|
|
124
116
|
Local development
|
|
125
117
|
=================
|
|
@@ -141,28 +133,28 @@ directory to the python path (or use ``python -m django <command>``):
|
|
|
141
133
|
# django-admin makemessages -l nl
|
|
142
134
|
|
|
143
135
|
|
|
144
|
-
.. |build-status| image:: https://github.com/maykinmedia/
|
|
136
|
+
.. |build-status| image:: https://github.com/maykinmedia/open-api-framework/workflows/Run%20CI/badge.svg
|
|
145
137
|
:alt: Build status
|
|
146
|
-
:target: https://github.com/maykinmedia/
|
|
138
|
+
:target: https://github.com/maykinmedia/open-api-framework/actions?query=workflow%3A%22Run+CI%22
|
|
147
139
|
|
|
148
|
-
.. |code-quality| image:: https://github.com/maykinmedia/
|
|
140
|
+
.. |code-quality| image:: https://github.com/maykinmedia/open-api-framework/workflows/Code%20quality%20checks/badge.svg
|
|
149
141
|
:alt: Code quality checks
|
|
150
|
-
:target: https://github.com/maykinmedia/
|
|
142
|
+
:target: https://github.com/maykinmedia/open-api-framework/actions?query=workflow%3A%22Code+quality+checks%22
|
|
151
143
|
|
|
152
144
|
.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
|
|
153
145
|
:target: https://github.com/psf/black
|
|
154
146
|
|
|
155
|
-
.. |coverage| image:: https://codecov.io/gh/maykinmedia/
|
|
156
|
-
:target: https://codecov.io/gh/maykinmedia/
|
|
147
|
+
.. |coverage| image:: https://codecov.io/gh/maykinmedia/open-api-framework/branch/main/graph/badge.svg
|
|
148
|
+
:target: https://codecov.io/gh/maykinmedia/open-api-framework
|
|
157
149
|
:alt: Coverage status
|
|
158
150
|
|
|
159
|
-
.. |docs| image:: https://readthedocs.org/projects/
|
|
160
|
-
:target: https://
|
|
151
|
+
.. |docs| image:: https://readthedocs.org/projects/open-api-framework/badge/?version=latest
|
|
152
|
+
:target: https://open-api-framework.readthedocs.io/en/latest/?badge=latest
|
|
161
153
|
:alt: Documentation Status
|
|
162
154
|
|
|
163
|
-
.. |python-versions| image:: https://img.shields.io/pypi/pyversions/
|
|
155
|
+
.. |python-versions| image:: https://img.shields.io/pypi/pyversions/open-api-framework.svg
|
|
164
156
|
|
|
165
|
-
.. |django-versions| image:: https://img.shields.io/pypi/djversions/
|
|
157
|
+
.. |django-versions| image:: https://img.shields.io/pypi/djversions/open-api-framework.svg
|
|
166
158
|
|
|
167
|
-
.. |pypi-version| image:: https://img.shields.io/pypi/v/
|
|
168
|
-
:target: https://pypi.org/project/
|
|
159
|
+
.. |pypi-version| image:: https://img.shields.io/pypi/v/open-api-framework.svg
|
|
160
|
+
:target: https://pypi.org/project/open-api-framework/
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
|
|
2
|
+
|
|
3
|
+
Welcome to open-api-framework's documentation!
|
|
4
|
+
=================================================
|
|
5
|
+
|
|
6
|
+
:Version: 0.2.0
|
|
7
|
+
:Source: https://github.com/maykinmedia/open-api-framework
|
|
8
|
+
:Keywords: metapackage, dependencies
|
|
9
|
+
|
|
10
|
+
|build-status| |code-quality| |black| |coverage| |docs|
|
|
11
|
+
|
|
12
|
+
|python-versions| |django-versions| |pypi-version|
|
|
13
|
+
|
|
14
|
+
A metapackage for registration components, that bundles the dependencies shared between these components
|
|
15
|
+
|
|
16
|
+
.. contents::
|
|
17
|
+
|
|
18
|
+
.. section-numbering::
|
|
19
|
+
|
|
20
|
+
Features
|
|
21
|
+
========
|
|
22
|
+
|
|
23
|
+
* Bundling shared dependencies and introducing minimum versions for these dependencies
|
|
24
|
+
|
|
25
|
+
Installation
|
|
26
|
+
============
|
|
27
|
+
|
|
28
|
+
Requirements
|
|
29
|
+
------------
|
|
30
|
+
|
|
31
|
+
* Python 3.9 or above
|
|
32
|
+
* Django 4.2 or newer
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
Install
|
|
36
|
+
-------
|
|
37
|
+
|
|
38
|
+
1. Add open-api-framework to your requirements file
|
|
39
|
+
2. Remove dependencies from your requirements file that occur in ``pyproject.toml``
|
|
40
|
+
3. Recompile the dependencies
|
|
41
|
+
|
|
42
|
+
Local development
|
|
43
|
+
=================
|
|
44
|
+
|
|
45
|
+
To install and develop the library locally, use::
|
|
46
|
+
|
|
47
|
+
.. code-block:: bash
|
|
48
|
+
|
|
49
|
+
pip install -e .[tests,coverage,docs,release]
|
|
50
|
+
|
|
51
|
+
When running management commands via ``django-admin``, make sure to add the root
|
|
52
|
+
directory to the python path (or use ``python -m django <command>``):
|
|
53
|
+
|
|
54
|
+
.. code-block:: bash
|
|
55
|
+
|
|
56
|
+
export PYTHONPATH=. DJANGO_SETTINGS_MODULE=testapp.settings
|
|
57
|
+
django-admin check
|
|
58
|
+
# or other commands like:
|
|
59
|
+
# django-admin makemessages -l nl
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
.. |build-status| image:: https://github.com/maykinmedia/open-api-framework/workflows/Run%20CI/badge.svg
|
|
63
|
+
:alt: Build status
|
|
64
|
+
:target: https://github.com/maykinmedia/open-api-framework/actions?query=workflow%3A%22Run+CI%22
|
|
65
|
+
|
|
66
|
+
.. |code-quality| image:: https://github.com/maykinmedia/open-api-framework/workflows/Code%20quality%20checks/badge.svg
|
|
67
|
+
:alt: Code quality checks
|
|
68
|
+
:target: https://github.com/maykinmedia/open-api-framework/actions?query=workflow%3A%22Code+quality+checks%22
|
|
69
|
+
|
|
70
|
+
.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
|
|
71
|
+
:target: https://github.com/psf/black
|
|
72
|
+
|
|
73
|
+
.. |coverage| image:: https://codecov.io/gh/maykinmedia/open-api-framework/branch/main/graph/badge.svg
|
|
74
|
+
:target: https://codecov.io/gh/maykinmedia/open-api-framework
|
|
75
|
+
:alt: Coverage status
|
|
76
|
+
|
|
77
|
+
.. |docs| image:: https://readthedocs.org/projects/open-api-framework/badge/?version=latest
|
|
78
|
+
:target: https://open-api-framework.readthedocs.io/en/latest/?badge=latest
|
|
79
|
+
:alt: Documentation Status
|
|
80
|
+
|
|
81
|
+
.. |python-versions| image:: https://img.shields.io/pypi/pyversions/open-api-framework.svg
|
|
82
|
+
|
|
83
|
+
.. |django-versions| image:: https://img.shields.io/pypi/djversions/open-api-framework.svg
|
|
84
|
+
|
|
85
|
+
.. |pypi-version| image:: https://img.shields.io/pypi/v/open-api-framework.svg
|
|
86
|
+
:target: https://pypi.org/project/open-api-framework/
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.1
|
|
2
2
|
Name: open_api_framework
|
|
3
|
-
Version: 0.
|
|
3
|
+
Version: 0.2.0
|
|
4
4
|
Summary: TODO
|
|
5
5
|
Author-email: Maykin Media <support@maykinmedia.nl>
|
|
6
6
|
License: Copyright 2024 Maykin Media
|
|
@@ -18,7 +18,6 @@ Project-URL: Source Code, https://github.com/maykinmedia/open_api_framework
|
|
|
18
18
|
Keywords: TODO
|
|
19
19
|
Classifier: Development Status :: 3 - Alpha
|
|
20
20
|
Classifier: Framework :: Django
|
|
21
|
-
Classifier: Framework :: Django :: 3.2
|
|
22
21
|
Classifier: Framework :: Django :: 4.2
|
|
23
22
|
Classifier: Intended Audience :: Developers
|
|
24
23
|
Classifier: Operating System :: Unix
|
|
@@ -31,7 +30,7 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
|
31
30
|
Requires-Python: >=3.9
|
|
32
31
|
Description-Content-Type: text/x-rst
|
|
33
32
|
License-File: LICENSE
|
|
34
|
-
Requires-Dist: django>=
|
|
33
|
+
Requires-Dist: django>=4.2.11
|
|
35
34
|
Requires-Dist: django-axes>=6.3.0
|
|
36
35
|
Requires-Dist: django-cors-headers>=4.3.1
|
|
37
36
|
Requires-Dist: django-markup>=1.8.1
|
|
@@ -56,6 +55,7 @@ Requires-Dist: sentry-sdk>=1.39.2
|
|
|
56
55
|
Requires-Dist: elastic-apm>=6.20.0
|
|
57
56
|
Requires-Dist: celery>=5.2.7
|
|
58
57
|
Requires-Dist: flower>=2.0.1
|
|
58
|
+
Requires-Dist: maykin-2fa>=1.0.0
|
|
59
59
|
Provides-Extra: tests
|
|
60
60
|
Requires-Dist: pytest; extra == "tests"
|
|
61
61
|
Requires-Dist: pytest-django; extra == "tests"
|
|
@@ -74,19 +74,18 @@ Requires-Dist: twine; extra == "release"
|
|
|
74
74
|
|
|
75
75
|
|
|
76
76
|
|
|
77
|
-
Welcome to
|
|
77
|
+
Welcome to open-api-framework's documentation!
|
|
78
78
|
=================================================
|
|
79
79
|
|
|
80
|
-
:Version: 0.
|
|
81
|
-
:Source: https://github.com/maykinmedia/
|
|
82
|
-
:Keywords:
|
|
83
|
-
:PythonVersion: 3.11
|
|
80
|
+
:Version: 0.2.0
|
|
81
|
+
:Source: https://github.com/maykinmedia/open-api-framework
|
|
82
|
+
:Keywords: metapackage, dependencies
|
|
84
83
|
|
|
85
84
|
|build-status| |code-quality| |black| |coverage| |docs|
|
|
86
85
|
|
|
87
86
|
|python-versions| |django-versions| |pypi-version|
|
|
88
87
|
|
|
89
|
-
|
|
88
|
+
A metapackage for registration components, that bundles the dependencies shared between these components
|
|
90
89
|
|
|
91
90
|
.. contents::
|
|
92
91
|
|
|
@@ -95,8 +94,7 @@ Welcome to open_api_framework's documentation!
|
|
|
95
94
|
Features
|
|
96
95
|
========
|
|
97
96
|
|
|
98
|
-
*
|
|
99
|
-
* ...
|
|
97
|
+
* Bundling shared dependencies and introducing minimum versions for these dependencies
|
|
100
98
|
|
|
101
99
|
Installation
|
|
102
100
|
============
|
|
@@ -104,22 +102,16 @@ Installation
|
|
|
104
102
|
Requirements
|
|
105
103
|
------------
|
|
106
104
|
|
|
107
|
-
* Python 3.9
|
|
108
|
-
* Django
|
|
105
|
+
* Python 3.9 or above
|
|
106
|
+
* Django 4.2 or newer
|
|
109
107
|
|
|
110
108
|
|
|
111
109
|
Install
|
|
112
110
|
-------
|
|
113
111
|
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
Usage
|
|
120
|
-
=====
|
|
121
|
-
|
|
122
|
-
<document or refer to docs>
|
|
112
|
+
1. Add open-api-framework to your requirements file
|
|
113
|
+
2. Remove dependencies from your requirements file that occur in ``pyproject.toml``
|
|
114
|
+
3. Recompile the dependencies
|
|
123
115
|
|
|
124
116
|
Local development
|
|
125
117
|
=================
|
|
@@ -141,28 +133,28 @@ directory to the python path (or use ``python -m django <command>``):
|
|
|
141
133
|
# django-admin makemessages -l nl
|
|
142
134
|
|
|
143
135
|
|
|
144
|
-
.. |build-status| image:: https://github.com/maykinmedia/
|
|
136
|
+
.. |build-status| image:: https://github.com/maykinmedia/open-api-framework/workflows/Run%20CI/badge.svg
|
|
145
137
|
:alt: Build status
|
|
146
|
-
:target: https://github.com/maykinmedia/
|
|
138
|
+
:target: https://github.com/maykinmedia/open-api-framework/actions?query=workflow%3A%22Run+CI%22
|
|
147
139
|
|
|
148
|
-
.. |code-quality| image:: https://github.com/maykinmedia/
|
|
140
|
+
.. |code-quality| image:: https://github.com/maykinmedia/open-api-framework/workflows/Code%20quality%20checks/badge.svg
|
|
149
141
|
:alt: Code quality checks
|
|
150
|
-
:target: https://github.com/maykinmedia/
|
|
142
|
+
:target: https://github.com/maykinmedia/open-api-framework/actions?query=workflow%3A%22Code+quality+checks%22
|
|
151
143
|
|
|
152
144
|
.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
|
|
153
145
|
:target: https://github.com/psf/black
|
|
154
146
|
|
|
155
|
-
.. |coverage| image:: https://codecov.io/gh/maykinmedia/
|
|
156
|
-
:target: https://codecov.io/gh/maykinmedia/
|
|
147
|
+
.. |coverage| image:: https://codecov.io/gh/maykinmedia/open-api-framework/branch/main/graph/badge.svg
|
|
148
|
+
:target: https://codecov.io/gh/maykinmedia/open-api-framework
|
|
157
149
|
:alt: Coverage status
|
|
158
150
|
|
|
159
|
-
.. |docs| image:: https://readthedocs.org/projects/
|
|
160
|
-
:target: https://
|
|
151
|
+
.. |docs| image:: https://readthedocs.org/projects/open-api-framework/badge/?version=latest
|
|
152
|
+
:target: https://open-api-framework.readthedocs.io/en/latest/?badge=latest
|
|
161
153
|
:alt: Documentation Status
|
|
162
154
|
|
|
163
|
-
.. |python-versions| image:: https://img.shields.io/pypi/pyversions/
|
|
155
|
+
.. |python-versions| image:: https://img.shields.io/pypi/pyversions/open-api-framework.svg
|
|
164
156
|
|
|
165
|
-
.. |django-versions| image:: https://img.shields.io/pypi/djversions/
|
|
157
|
+
.. |django-versions| image:: https://img.shields.io/pypi/djversions/open-api-framework.svg
|
|
166
158
|
|
|
167
|
-
.. |pypi-version| image:: https://img.shields.io/pypi/v/
|
|
168
|
-
:target: https://pypi.org/project/
|
|
159
|
+
.. |pypi-version| image:: https://img.shields.io/pypi/v/open-api-framework.svg
|
|
160
|
+
:target: https://pypi.org/project/open-api-framework/
|
|
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
|
|
|
4
4
|
|
|
5
5
|
[project]
|
|
6
6
|
name = "open_api_framework"
|
|
7
|
-
version = "0.
|
|
7
|
+
version = "0.2.0"
|
|
8
8
|
description = "TODO"
|
|
9
9
|
authors = [
|
|
10
10
|
{name = "Maykin Media", email = "support@maykinmedia.nl"}
|
|
@@ -15,7 +15,6 @@ keywords = ["TODO"]
|
|
|
15
15
|
classifiers = [
|
|
16
16
|
"Development Status :: 3 - Alpha",
|
|
17
17
|
"Framework :: Django",
|
|
18
|
-
"Framework :: Django :: 3.2",
|
|
19
18
|
"Framework :: Django :: 4.2",
|
|
20
19
|
"Intended Audience :: Developers",
|
|
21
20
|
"Operating System :: Unix",
|
|
@@ -28,7 +27,7 @@ classifiers = [
|
|
|
28
27
|
]
|
|
29
28
|
requires-python = ">=3.9"
|
|
30
29
|
dependencies = [
|
|
31
|
-
"django>=
|
|
30
|
+
"django>=4.2.11",
|
|
32
31
|
"django-axes>=6.3.0",
|
|
33
32
|
"django-cors-headers>=4.3.1",
|
|
34
33
|
"django-markup>=1.8.1",
|
|
@@ -53,6 +52,7 @@ dependencies = [
|
|
|
53
52
|
"elastic-apm>=6.20.0",
|
|
54
53
|
"celery>=5.2.7",
|
|
55
54
|
"flower>=2.0.1",
|
|
55
|
+
"maykin-2fa>=1.0.0",
|
|
56
56
|
]
|
|
57
57
|
|
|
58
58
|
[project.urls]
|
|
@@ -98,7 +98,7 @@ testpaths = ["tests"]
|
|
|
98
98
|
DJANGO_SETTINGS_MODULE = "testapp.settings"
|
|
99
99
|
|
|
100
100
|
[tool.bumpversion]
|
|
101
|
-
current_version = "0.
|
|
101
|
+
current_version = "0.2.0"
|
|
102
102
|
files = [
|
|
103
103
|
{filename = "pyproject.toml"},
|
|
104
104
|
{filename = "README.rst"},
|
|
@@ -1,94 +0,0 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
Welcome to open_api_framework's documentation!
|
|
4
|
-
=================================================
|
|
5
|
-
|
|
6
|
-
:Version: 0.1.0
|
|
7
|
-
:Source: https://github.com/maykinmedia/open_api_framework
|
|
8
|
-
:Keywords: ``<keywords>``
|
|
9
|
-
:PythonVersion: 3.11
|
|
10
|
-
|
|
11
|
-
|build-status| |code-quality| |black| |coverage| |docs|
|
|
12
|
-
|
|
13
|
-
|python-versions| |django-versions| |pypi-version|
|
|
14
|
-
|
|
15
|
-
<One liner describing the project>
|
|
16
|
-
|
|
17
|
-
.. contents::
|
|
18
|
-
|
|
19
|
-
.. section-numbering::
|
|
20
|
-
|
|
21
|
-
Features
|
|
22
|
-
========
|
|
23
|
-
|
|
24
|
-
* ...
|
|
25
|
-
* ...
|
|
26
|
-
|
|
27
|
-
Installation
|
|
28
|
-
============
|
|
29
|
-
|
|
30
|
-
Requirements
|
|
31
|
-
------------
|
|
32
|
-
|
|
33
|
-
* Python 3.9/3.11 or above
|
|
34
|
-
* Django 3.2/4.2 or newer
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
Install
|
|
38
|
-
-------
|
|
39
|
-
|
|
40
|
-
.. code-block:: bash
|
|
41
|
-
|
|
42
|
-
pip install open_api_framework
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
Usage
|
|
46
|
-
=====
|
|
47
|
-
|
|
48
|
-
<document or refer to docs>
|
|
49
|
-
|
|
50
|
-
Local development
|
|
51
|
-
=================
|
|
52
|
-
|
|
53
|
-
To install and develop the library locally, use::
|
|
54
|
-
|
|
55
|
-
.. code-block:: bash
|
|
56
|
-
|
|
57
|
-
pip install -e .[tests,coverage,docs,release]
|
|
58
|
-
|
|
59
|
-
When running management commands via ``django-admin``, make sure to add the root
|
|
60
|
-
directory to the python path (or use ``python -m django <command>``):
|
|
61
|
-
|
|
62
|
-
.. code-block:: bash
|
|
63
|
-
|
|
64
|
-
export PYTHONPATH=. DJANGO_SETTINGS_MODULE=testapp.settings
|
|
65
|
-
django-admin check
|
|
66
|
-
# or other commands like:
|
|
67
|
-
# django-admin makemessages -l nl
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
.. |build-status| image:: https://github.com/maykinmedia/open_api_framework/workflows/Run%20CI/badge.svg
|
|
71
|
-
:alt: Build status
|
|
72
|
-
:target: https://github.com/maykinmedia/open_api_framework/actions?query=workflow%3A%22Run+CI%22
|
|
73
|
-
|
|
74
|
-
.. |code-quality| image:: https://github.com/maykinmedia/open_api_framework/workflows/Code%20quality%20checks/badge.svg
|
|
75
|
-
:alt: Code quality checks
|
|
76
|
-
:target: https://github.com/maykinmedia/open_api_framework/actions?query=workflow%3A%22Code+quality+checks%22
|
|
77
|
-
|
|
78
|
-
.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
|
|
79
|
-
:target: https://github.com/psf/black
|
|
80
|
-
|
|
81
|
-
.. |coverage| image:: https://codecov.io/gh/maykinmedia/open_api_framework/branch/main/graph/badge.svg
|
|
82
|
-
:target: https://codecov.io/gh/maykinmedia/open_api_framework
|
|
83
|
-
:alt: Coverage status
|
|
84
|
-
|
|
85
|
-
.. |docs| image:: https://readthedocs.org/projects/open_api_framework/badge/?version=latest
|
|
86
|
-
:target: https://open_api_framework.readthedocs.io/en/latest/?badge=latest
|
|
87
|
-
:alt: Documentation Status
|
|
88
|
-
|
|
89
|
-
.. |python-versions| image:: https://img.shields.io/pypi/pyversions/open_api_framework.svg
|
|
90
|
-
|
|
91
|
-
.. |django-versions| image:: https://img.shields.io/pypi/djversions/open_api_framework.svg
|
|
92
|
-
|
|
93
|
-
.. |pypi-version| image:: https://img.shields.io/pypi/v/open_api_framework.svg
|
|
94
|
-
:target: https://pypi.org/project/open_api_framework/
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{open_api_framework-0.1.0 → open_api_framework-0.2.0}/open_api_framework.egg-info/SOURCES.txt
RENAMED
|
File without changes
|
|
File without changes
|
{open_api_framework-0.1.0 → open_api_framework-0.2.0}/open_api_framework.egg-info/top_level.txt
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|