edx-api-doc-tools 2.1.0__tar.gz → 2.1.2__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.
- {edx_api_doc_tools-2.1.0 → edx_api_doc_tools-2.1.2}/CHANGELOG.rst +9 -3
- {edx_api_doc_tools-2.1.0/edx_api_doc_tools.egg-info → edx_api_doc_tools-2.1.2}/PKG-INFO +22 -6
- {edx_api_doc_tools-2.1.0 → edx_api_doc_tools-2.1.2}/edx_api_doc_tools/__init__.py +1 -1
- {edx_api_doc_tools-2.1.0 → edx_api_doc_tools-2.1.2/edx_api_doc_tools.egg-info}/PKG-INFO +22 -6
- {edx_api_doc_tools-2.1.0 → edx_api_doc_tools-2.1.2}/setup.py +56 -39
- {edx_api_doc_tools-2.1.0 → edx_api_doc_tools-2.1.2}/LICENSE.txt +0 -0
- {edx_api_doc_tools-2.1.0 → edx_api_doc_tools-2.1.2}/MANIFEST.in +0 -0
- {edx_api_doc_tools-2.1.0 → edx_api_doc_tools-2.1.2}/README.rst +0 -0
- {edx_api_doc_tools-2.1.0 → edx_api_doc_tools-2.1.2}/edx_api_doc_tools/apps.py +0 -0
- {edx_api_doc_tools-2.1.0 → edx_api_doc_tools-2.1.2}/edx_api_doc_tools/conf_utils.py +0 -0
- {edx_api_doc_tools-2.1.0 → edx_api_doc_tools-2.1.2}/edx_api_doc_tools/data.py +0 -0
- {edx_api_doc_tools-2.1.0 → edx_api_doc_tools-2.1.2}/edx_api_doc_tools/internal_utils.py +0 -0
- {edx_api_doc_tools-2.1.0 → edx_api_doc_tools-2.1.2}/edx_api_doc_tools/urls.py +0 -0
- {edx_api_doc_tools-2.1.0 → edx_api_doc_tools-2.1.2}/edx_api_doc_tools/view_utils.py +0 -0
- {edx_api_doc_tools-2.1.0 → edx_api_doc_tools-2.1.2}/edx_api_doc_tools.egg-info/SOURCES.txt +0 -0
- {edx_api_doc_tools-2.1.0 → edx_api_doc_tools-2.1.2}/edx_api_doc_tools.egg-info/dependency_links.txt +0 -0
- {edx_api_doc_tools-2.1.0 → edx_api_doc_tools-2.1.2}/edx_api_doc_tools.egg-info/not-zip-safe +0 -0
- {edx_api_doc_tools-2.1.0 → edx_api_doc_tools-2.1.2}/edx_api_doc_tools.egg-info/requires.txt +0 -0
- {edx_api_doc_tools-2.1.0 → edx_api_doc_tools-2.1.2}/edx_api_doc_tools.egg-info/top_level.txt +0 -0
- {edx_api_doc_tools-2.1.0 → edx_api_doc_tools-2.1.2}/requirements/base.in +0 -0
- {edx_api_doc_tools-2.1.0 → edx_api_doc_tools-2.1.2}/requirements/constraints.txt +0 -0
- {edx_api_doc_tools-2.1.0 → edx_api_doc_tools-2.1.2}/setup.cfg +0 -0
- {edx_api_doc_tools-2.1.0 → edx_api_doc_tools-2.1.2}/tests/test_doc_tools.py +0 -0
- {edx_api_doc_tools-2.1.0 → edx_api_doc_tools-2.1.2}/tests/test_example.py +0 -0
|
@@ -14,8 +14,16 @@ Change Log
|
|
|
14
14
|
Unreleased
|
|
15
15
|
----------
|
|
16
16
|
|
|
17
|
+
2.1.2 - 2026-01-39
|
|
18
|
+
------------------
|
|
19
|
+
* Fix builds to PyPI
|
|
20
|
+
|
|
21
|
+
2.1.1 - 2026-01-39
|
|
22
|
+
------------------
|
|
23
|
+
* Fix make upgrade, update dependencies
|
|
24
|
+
|
|
17
25
|
2.1.0 - 2025-04-18
|
|
18
|
-
|
|
26
|
+
------------------
|
|
19
27
|
* Added Support for ``django 5.2``.
|
|
20
28
|
|
|
21
29
|
2.0.0 --- 2024-09-09
|
|
@@ -28,8 +36,6 @@ Unreleased
|
|
|
28
36
|
* Add support for python 3.11 and 3.12 support.
|
|
29
37
|
* Removed django32 support.
|
|
30
38
|
|
|
31
|
-
|
|
32
|
-
|
|
33
39
|
1.7.0 --- 2023-07-23
|
|
34
40
|
--------------------
|
|
35
41
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
Metadata-Version: 2.
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
2
|
Name: edx-api-doc-tools
|
|
3
|
-
Version: 2.1.
|
|
3
|
+
Version: 2.1.2
|
|
4
4
|
Summary: Tools for writing and generating API documentation for edX REST APIs
|
|
5
5
|
Home-page: https://github.com/openedx/api-doc-tools
|
|
6
6
|
Author: Open edX Project
|
|
@@ -15,7 +15,6 @@ Classifier: Intended Audience :: Developers
|
|
|
15
15
|
Classifier: License :: OSI Approved :: Apache Software License
|
|
16
16
|
Classifier: Natural Language :: English
|
|
17
17
|
Classifier: Programming Language :: Python :: 3
|
|
18
|
-
Classifier: Programming Language :: Python :: 3.8
|
|
19
18
|
Classifier: Programming Language :: Python :: 3.11
|
|
20
19
|
Classifier: Programming Language :: Python :: 3.12
|
|
21
20
|
Description-Content-Type: text/x-rst
|
|
@@ -24,6 +23,17 @@ Requires-Dist: Django
|
|
|
24
23
|
Requires-Dist: djangorestframework>=3.2.0
|
|
25
24
|
Requires-Dist: drf-yasg
|
|
26
25
|
Requires-Dist: setuptools
|
|
26
|
+
Dynamic: author
|
|
27
|
+
Dynamic: author-email
|
|
28
|
+
Dynamic: classifier
|
|
29
|
+
Dynamic: description
|
|
30
|
+
Dynamic: description-content-type
|
|
31
|
+
Dynamic: home-page
|
|
32
|
+
Dynamic: keywords
|
|
33
|
+
Dynamic: license
|
|
34
|
+
Dynamic: license-file
|
|
35
|
+
Dynamic: requires-dist
|
|
36
|
+
Dynamic: summary
|
|
27
37
|
|
|
28
38
|
edX API Documentation Tools
|
|
29
39
|
===========================
|
|
@@ -140,8 +150,16 @@ Change Log
|
|
|
140
150
|
Unreleased
|
|
141
151
|
----------
|
|
142
152
|
|
|
153
|
+
2.1.2 - 2026-01-39
|
|
154
|
+
------------------
|
|
155
|
+
* Fix builds to PyPI
|
|
156
|
+
|
|
157
|
+
2.1.1 - 2026-01-39
|
|
158
|
+
------------------
|
|
159
|
+
* Fix make upgrade, update dependencies
|
|
160
|
+
|
|
143
161
|
2.1.0 - 2025-04-18
|
|
144
|
-
|
|
162
|
+
------------------
|
|
145
163
|
* Added Support for ``django 5.2``.
|
|
146
164
|
|
|
147
165
|
2.0.0 --- 2024-09-09
|
|
@@ -154,8 +172,6 @@ Unreleased
|
|
|
154
172
|
* Add support for python 3.11 and 3.12 support.
|
|
155
173
|
* Removed django32 support.
|
|
156
174
|
|
|
157
|
-
|
|
158
|
-
|
|
159
175
|
1.7.0 --- 2023-07-23
|
|
160
176
|
--------------------
|
|
161
177
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
Metadata-Version: 2.
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
2
|
Name: edx-api-doc-tools
|
|
3
|
-
Version: 2.1.
|
|
3
|
+
Version: 2.1.2
|
|
4
4
|
Summary: Tools for writing and generating API documentation for edX REST APIs
|
|
5
5
|
Home-page: https://github.com/openedx/api-doc-tools
|
|
6
6
|
Author: Open edX Project
|
|
@@ -15,7 +15,6 @@ Classifier: Intended Audience :: Developers
|
|
|
15
15
|
Classifier: License :: OSI Approved :: Apache Software License
|
|
16
16
|
Classifier: Natural Language :: English
|
|
17
17
|
Classifier: Programming Language :: Python :: 3
|
|
18
|
-
Classifier: Programming Language :: Python :: 3.8
|
|
19
18
|
Classifier: Programming Language :: Python :: 3.11
|
|
20
19
|
Classifier: Programming Language :: Python :: 3.12
|
|
21
20
|
Description-Content-Type: text/x-rst
|
|
@@ -24,6 +23,17 @@ Requires-Dist: Django
|
|
|
24
23
|
Requires-Dist: djangorestframework>=3.2.0
|
|
25
24
|
Requires-Dist: drf-yasg
|
|
26
25
|
Requires-Dist: setuptools
|
|
26
|
+
Dynamic: author
|
|
27
|
+
Dynamic: author-email
|
|
28
|
+
Dynamic: classifier
|
|
29
|
+
Dynamic: description
|
|
30
|
+
Dynamic: description-content-type
|
|
31
|
+
Dynamic: home-page
|
|
32
|
+
Dynamic: keywords
|
|
33
|
+
Dynamic: license
|
|
34
|
+
Dynamic: license-file
|
|
35
|
+
Dynamic: requires-dist
|
|
36
|
+
Dynamic: summary
|
|
27
37
|
|
|
28
38
|
edX API Documentation Tools
|
|
29
39
|
===========================
|
|
@@ -140,8 +150,16 @@ Change Log
|
|
|
140
150
|
Unreleased
|
|
141
151
|
----------
|
|
142
152
|
|
|
153
|
+
2.1.2 - 2026-01-39
|
|
154
|
+
------------------
|
|
155
|
+
* Fix builds to PyPI
|
|
156
|
+
|
|
157
|
+
2.1.1 - 2026-01-39
|
|
158
|
+
------------------
|
|
159
|
+
* Fix make upgrade, update dependencies
|
|
160
|
+
|
|
143
161
|
2.1.0 - 2025-04-18
|
|
144
|
-
|
|
162
|
+
------------------
|
|
145
163
|
* Added Support for ``django 5.2``.
|
|
146
164
|
|
|
147
165
|
2.0.0 --- 2024-09-09
|
|
@@ -154,8 +172,6 @@ Unreleased
|
|
|
154
172
|
* Add support for python 3.11 and 3.12 support.
|
|
155
173
|
* Removed django32 support.
|
|
156
174
|
|
|
157
|
-
|
|
158
|
-
|
|
159
175
|
1.7.0 --- 2023-07-23
|
|
160
176
|
--------------------
|
|
161
177
|
|
|
@@ -19,12 +19,11 @@ def get_version(*file_paths):
|
|
|
19
19
|
Extract the version string from the file at the given relative path fragments.
|
|
20
20
|
"""
|
|
21
21
|
filename = os.path.join(os.path.dirname(__file__), *file_paths)
|
|
22
|
-
version_file = open(filename,
|
|
23
|
-
version_match = re.search(r"^__version__ = ['\"]([^'\"]*)['\"]",
|
|
24
|
-
version_file, re.M)
|
|
22
|
+
version_file = open(filename, encoding="utf-8").read()
|
|
23
|
+
version_match = re.search(r"^__version__ = ['\"]([^'\"]*)['\"]", version_file, re.M)
|
|
25
24
|
if version_match:
|
|
26
25
|
return version_match.group(1)
|
|
27
|
-
raise RuntimeError(
|
|
26
|
+
raise RuntimeError("Unable to find version string.")
|
|
28
27
|
|
|
29
28
|
|
|
30
29
|
def load_requirements(*requirements_paths):
|
|
@@ -49,14 +48,14 @@ def load_requirements(*requirements_paths):
|
|
|
49
48
|
with extras we don't constrain it without mentioning the extras (since
|
|
50
49
|
that too would interfere with matching constraints.)
|
|
51
50
|
"""
|
|
52
|
-
canonical = package.lower().replace(
|
|
51
|
+
canonical = package.lower().replace("_", "-").split("[")[0]
|
|
53
52
|
seen_spelling = by_canonical_name.get(canonical)
|
|
54
53
|
if seen_spelling is None:
|
|
55
54
|
by_canonical_name[canonical] = package
|
|
56
55
|
elif seen_spelling != package:
|
|
57
56
|
raise RuntimeError(
|
|
58
57
|
f'Encountered both "{seen_spelling}" and "{package}" in requirements '
|
|
59
|
-
|
|
58
|
+
"and constraints files; please use just one or the other."
|
|
60
59
|
)
|
|
61
60
|
|
|
62
61
|
requirements = {}
|
|
@@ -70,7 +69,9 @@ def load_requirements(*requirements_paths):
|
|
|
70
69
|
% (re_package_name_base_chars, re_package_name_base_chars)
|
|
71
70
|
)
|
|
72
71
|
|
|
73
|
-
def add_version_constraint_or_raise(
|
|
72
|
+
def add_version_constraint_or_raise(
|
|
73
|
+
current_line, current_requirements, add_if_not_present
|
|
74
|
+
):
|
|
74
75
|
regex_match = requirement_line_regex.match(current_line)
|
|
75
76
|
if regex_match:
|
|
76
77
|
package = regex_match.group(1)
|
|
@@ -79,11 +80,16 @@ def load_requirements(*requirements_paths):
|
|
|
79
80
|
existing_version_constraints = current_requirements.get(package, None)
|
|
80
81
|
# It's fine to add constraints to an unconstrained package,
|
|
81
82
|
# but raise an error if there are already constraints in place.
|
|
82
|
-
if
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
83
|
+
if (
|
|
84
|
+
existing_version_constraints
|
|
85
|
+
and existing_version_constraints != version_constraints
|
|
86
|
+
):
|
|
87
|
+
raise BaseException(
|
|
88
|
+
f"Multiple constraint definitions found for {package}:"
|
|
89
|
+
f' "{existing_version_constraints}" and "{version_constraints}".'
|
|
90
|
+
f"Combine constraints into one location with {package}"
|
|
91
|
+
f"{existing_version_constraints},{version_constraints}."
|
|
92
|
+
)
|
|
87
93
|
if add_if_not_present or package in current_requirements:
|
|
88
94
|
current_requirements[package] = version_constraints
|
|
89
95
|
|
|
@@ -94,8 +100,12 @@ def load_requirements(*requirements_paths):
|
|
|
94
100
|
for line in reqs:
|
|
95
101
|
if is_requirement(line):
|
|
96
102
|
add_version_constraint_or_raise(line, requirements, True)
|
|
97
|
-
if line and line.startswith(
|
|
98
|
-
constraint_files.add(
|
|
103
|
+
if line and line.startswith("-c") and not line.startswith("-c http"):
|
|
104
|
+
constraint_files.add(
|
|
105
|
+
os.path.dirname(path)
|
|
106
|
+
+ "/"
|
|
107
|
+
+ line.split("#")[0].replace("-c", "").strip()
|
|
108
|
+
)
|
|
99
109
|
|
|
100
110
|
# process constraint files: add constraints to existing requirements
|
|
101
111
|
for constraint_file in constraint_files:
|
|
@@ -105,7 +115,9 @@ def load_requirements(*requirements_paths):
|
|
|
105
115
|
add_version_constraint_or_raise(line, requirements, False)
|
|
106
116
|
|
|
107
117
|
# process back into list of pkg><=constraints strings
|
|
108
|
-
constrained_requirements = [
|
|
118
|
+
constrained_requirements = [
|
|
119
|
+
f"{pkg}{version or ''}" for (pkg, version) in sorted(requirements.items())
|
|
120
|
+
]
|
|
109
121
|
return constrained_requirements
|
|
110
122
|
|
|
111
123
|
|
|
@@ -119,48 +131,53 @@ def is_requirement(line):
|
|
|
119
131
|
"""
|
|
120
132
|
# UPDATED VIA SEMGREP - if you need to remove/modify this method remove this line and add a comment specifying why
|
|
121
133
|
|
|
122
|
-
return
|
|
134
|
+
return (
|
|
135
|
+
line and line.strip() and not line.startswith(("-r", "#", "-e", "git+", "-c"))
|
|
136
|
+
)
|
|
123
137
|
|
|
124
138
|
|
|
125
|
-
VERSION = get_version(
|
|
139
|
+
VERSION = get_version("edx_api_doc_tools", "__init__.py")
|
|
126
140
|
|
|
127
|
-
if sys.argv[-1] ==
|
|
141
|
+
if sys.argv[-1] == "tag":
|
|
128
142
|
print("Tagging the version on github:")
|
|
129
143
|
os.system("git tag -a %s -m 'version %s'" % (VERSION, VERSION))
|
|
130
144
|
os.system("git push --tags")
|
|
131
145
|
sys.exit()
|
|
132
146
|
|
|
133
|
-
README = open(
|
|
134
|
-
|
|
147
|
+
README = open(
|
|
148
|
+
os.path.join(os.path.dirname(__file__), "README.rst"), encoding="utf-8"
|
|
149
|
+
).read()
|
|
150
|
+
CHANGELOG = open(
|
|
151
|
+
os.path.join(os.path.dirname(__file__), "CHANGELOG.rst"), encoding="utf-8"
|
|
152
|
+
).read()
|
|
135
153
|
|
|
136
154
|
setup(
|
|
137
|
-
name=
|
|
155
|
+
name="edx-api-doc-tools",
|
|
138
156
|
version=VERSION,
|
|
139
157
|
description="Tools for writing and generating API documentation for edX REST APIs",
|
|
140
|
-
long_description=README +
|
|
158
|
+
long_description=README + "\n\n" + CHANGELOG,
|
|
141
159
|
long_description_content_type="text/x-rst",
|
|
142
|
-
author=
|
|
143
|
-
author_email=
|
|
144
|
-
url=
|
|
160
|
+
author="Open edX Project",
|
|
161
|
+
author_email="oscm@openedx.org",
|
|
162
|
+
url="https://github.com/openedx/api-doc-tools",
|
|
145
163
|
packages=[
|
|
146
|
-
|
|
164
|
+
"edx_api_doc_tools",
|
|
147
165
|
],
|
|
148
166
|
include_package_data=True,
|
|
149
|
-
install_requires=load_requirements(
|
|
167
|
+
install_requires=load_requirements("requirements/base.in"),
|
|
150
168
|
license="Apache Software License 2.0",
|
|
151
169
|
zip_safe=False,
|
|
152
|
-
keywords=
|
|
170
|
+
keywords="Django edx",
|
|
153
171
|
classifiers=[
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
'Programming Language :: Python :: 3.12',
|
|
172
|
+
"Development Status :: 3 - Alpha",
|
|
173
|
+
"Framework :: Django",
|
|
174
|
+
"Framework :: Django :: 4.2",
|
|
175
|
+
"Framework :: Django :: 5.2",
|
|
176
|
+
"Intended Audience :: Developers",
|
|
177
|
+
"License :: OSI Approved :: Apache Software License",
|
|
178
|
+
"Natural Language :: English",
|
|
179
|
+
"Programming Language :: Python :: 3",
|
|
180
|
+
"Programming Language :: Python :: 3.11",
|
|
181
|
+
"Programming Language :: Python :: 3.12",
|
|
165
182
|
],
|
|
166
183
|
)
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{edx_api_doc_tools-2.1.0 → edx_api_doc_tools-2.1.2}/edx_api_doc_tools.egg-info/dependency_links.txt
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
{edx_api_doc_tools-2.1.0 → edx_api_doc_tools-2.1.2}/edx_api_doc_tools.egg-info/top_level.txt
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|