code-annotations 1.8.2__tar.gz → 2.1.0__tar.gz

{code-annotations-1.8.2 → code_annotations-2.1.0}/CHANGELOG.rst

@@ -14,6 +14,17 @@ Change Log
 Unreleased
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+[2.1.0] - 2024-12-12
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* Add support for optional event warning for in-line annotation.
+
+[2.0.0] - 2024-10-18
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* Drop support for python 3.8
+* Adds support for python 3.11 & 3.12
+
 [1.8.1] - 2024-07-11
 ~~~~~~~~~~~~~~~~~~~~
 

{code-annotations-1.8.2 → code_annotations-2.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: code-annotations
-Version: 1.8.2
+Version: 2.1.0
 Summary: Extensible tools for parsing annotations in codebases
 Home-page: https://github.com/openedx/code-annotations
 Author: edX
@@ -15,19 +15,19 @@ Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Natural Language :: English
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.11
 Description-Content-Type: text/x-rst
 License-File: LICENSE.txt
 License-File: NOTICE.txt
-Requires-Dist: pyyaml
-Requires-Dist: Jinja2
-Requires-Dist: stevedore
 Requires-Dist: python-slugify
+Requires-Dist: stevedore
+Requires-Dist: pyyaml
 Requires-Dist: click
+Requires-Dist: Jinja2
 Provides-Extra: django
-Requires-Dist: Django<2.3,>=2.2; extra == "django"
+Requires-Dist: Django>=4.2; extra == "django"
 
 code-annotations
 =============================
@@ -129,6 +129,17 @@ Change Log
 Unreleased
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+[2.1.0] - 2024-12-12
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* Add support for optional event warning for in-line annotation.
+
+[2.0.0] - 2024-10-18
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* Drop support for python 3.8
+* Adds support for python 3.11 & 3.12
+
 [1.8.1] - 2024-07-11
 ~~~~~~~~~~~~~~~~~~~~
 

{code-annotations-1.8.2 → code_annotations-2.1.0}/code_annotations/__init__.py

@@ -2,4 +2,4 @@
 Extensible tools for parsing annotations in codebases.
 """
 
-__version__ = '1.8.2'
+__version__ = '2.1.0'

{code-annotations-1.8.2 → code_annotations-2.1.0}/code_annotations/contrib/config/openedx_events_annotations.yaml

@@ -6,12 +6,13 @@ safelist_path: .annotation_safe_list.yml
 coverage_target: 100.0
 annotations:
   feature_toggle:
-    # See annotation format documentation: https://edx-toggles.readthedocs.io/en/latest/how_to/documenting_new_feature_toggles.html
+    # See annotation format documentation: https://docs.openedx.org/projects/openedx-events/en/latest/reference/in-line-code-annotations-for-an-event.html
     - ".. event_type:":
     - ".. event_name:":
     - ".. event_description:":
     - ".. event_data:":
     - ".. event_key_field:":
+    - ".. event_warning:":
 extensions:
     python:
         - py

{code-annotations-1.8.2 → code_annotations-2.1.0}/code_annotations/contrib/sphinx/extensions/openedx_events.py

@@ -118,6 +118,11 @@ class OpenedxEvents(SphinxDirective):
                      f" {event['line_number']})"
             )
 
+            if event.get(".. event_warning:") not in (None, "None", "n/a", "N/A"):
+                event_section += nodes.warning(
+                    "", nodes.paragraph("", event[".. event_warning:"]), ids=[f"warning-{event_name}"]
+                )
+
             subject_header += event_section
 
         if domain_header:

{code-annotations-1.8.2 → code_annotations-2.1.0}/code_annotations.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: code-annotations
-Version: 1.8.2
+Version: 2.1.0
 Summary: Extensible tools for parsing annotations in codebases
 Home-page: https://github.com/openedx/code-annotations
 Author: edX
@@ -15,19 +15,19 @@ Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Natural Language :: English
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.11
 Description-Content-Type: text/x-rst
 License-File: LICENSE.txt
 License-File: NOTICE.txt
-Requires-Dist: pyyaml
-Requires-Dist: Jinja2
-Requires-Dist: stevedore
 Requires-Dist: python-slugify
+Requires-Dist: stevedore
+Requires-Dist: pyyaml
 Requires-Dist: click
+Requires-Dist: Jinja2
 Provides-Extra: django
-Requires-Dist: Django<2.3,>=2.2; extra == "django"
+Requires-Dist: Django>=4.2; extra == "django"
 
 code-annotations
 =============================
@@ -129,6 +129,17 @@ Change Log
 Unreleased
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+[2.1.0] - 2024-12-12
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* Add support for optional event warning for in-line annotation.
+
+[2.0.0] - 2024-10-18
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* Drop support for python 3.8
+* Adds support for python 3.11 & 3.12
+
 [1.8.1] - 2024-07-11
 ~~~~~~~~~~~~~~~~~~~~
 

{code-annotations-1.8.2 → code_annotations-2.1.0}/code_annotations.egg-info/requires.txt

@@ -1,8 +1,8 @@
-pyyaml
-Jinja2
-stevedore
 python-slugify
+stevedore
+pyyaml
 click
+Jinja2
 
 [django]
-Django<2.3,>=2.2
+Django>=4.2

{code-annotations-1.8.2 → code_annotations-2.1.0}/setup.py

@@ -90,10 +90,11 @@ setup(
     },
     include_package_data=True,
     install_requires=load_requirements('requirements/base.in'),
-    extras_require={"django": ["Django>=2.2,<2.3"]},
+    extras_require={"django": ["Django>=4.2"]},
     license="Apache Software License 2.0",
     zip_safe=False,
     keywords='edx pii code annotations',
+    python_requires=">=3.11",
     classifiers=[
         'Development Status :: 3 - Alpha',
         'Framework :: Django',
@@ -103,7 +104,6 @@ setup(
         'Natural Language :: English',
         'Programming Language :: Python',
         'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.8',
         'Programming Language :: Python :: 3.11',
         'Programming Language :: Python :: 3.12',
     ],