Package: code-annotations
Extensible tools for parsing annotations in codebasesOverviewThis package provides configurable and extensible tools for parsing and
summarizing annotations in a wide range of codebases. Originally intended for
annotating code which stores personally identifiable information (PII), these
tools are optimized for that use case but can be generalized for other types of
annotations.Additionally, a logically separate part of this repository will contain specific annotation configurations and supporting tools, such as Sphinx extensions for documenting specific annotation types. See thecontribfolder.DocumentationThe full documentation is athttps://code-annotations.readthedocs.org.LicenseThe code in this repository is licensed under the Apache Software License 2.0 unless
otherwise noted.Please seeLICENSE.txtfor details.How To ContributeContributions are very welcome.Please readHow To Contributefor details.PR description template should be automatically applied if you are sending PR from github interface; otherwise you
can find it it atPULL_REQUEST_TEMPLATE.mdIssue report template should be automatically applied if you are sending it from github UI as well; otherwise you
can find it atISSUE_TEMPLATE.mdReporting Security IssuesPlease do not report security issues in public. Please emailsecurity@openedx.org.Getting HelpHave a question about this repository, or about Open edX in general?  Please
refer to thislist of resourcesif you need any assistance.Change LogUnreleased[1.6.0] - 2024-01-31Added new annotationtoggle_removal_ticket[1.5.0] - 2023-07-21Switch fromedx-sphinx-themetosphinx-book-themesince the former is
deprecatedAdded Support for Django 4.2[1.4.0] - 2022-05-23Rename toggle_warnings to toggle_warning for consistency with setting_warning.[1.3.0] - 2022-02-07Dropped Django 22, 30 and 31 SupportAdded Django40 Support in CI[1.2.0] - 2021-07-26Added Django 3.0, 3.1 & 3.2 Support[1.1.2] - 2021-05-21Django is not a base requirement for the package now.Removed the click constraint from base requirements.[1.1.1] - 2021-03-30Internal refactoring of the sphinx utilities and the report generation code[1.1.0] - 2021-01-28Refactor annotation checking to make it possible to expose errors via pylint[1.0.2] - 2021-01-22Make setting_warning annotation optional.[1.0.1] - 2021-01-22Fix grouping of safelisted annotations[1.0.0] - 2021-01-21BREAKING CHANGE: Improvement of some error messagesBREAKING CHANGE: Refactor linting in a way that breaks backward compatibility of certain edge casesImplement optional annotation fields[0.10.3] - 2020-12-15Updated the travis-badge in README.rst to point to travis-ci.com[0.10.1] - 2020-11-09Fix Github links generated by the sphinx extension for settings.[0.10.0] - 2020-10-12Fix table of contents generated by sphinx extensions[0.9.0] - 2020-09-25Get rid of thedocumented_elsewhereannotation, which is used nowhere[0.8.0] - 2020-09-10AddsettingsSphinx extension with setting annotation configuration file[0.7.0] - 2020-09-07Simplify the feature toggle annotation format[0.6.0] - 2020-08-27Add support for multiline annotations for lines prefixed with single-line comment signs (“#”)[0.5.1] - 2020-08-25Add support for warnings in thefeaturetogglesSphinx extension[0.5.0] - 2020-08-06AddfeaturetogglesSphinx extensionIncludecontribfolder in pip-installable packageAdd ADR 0001-config-and-tools.rst for adding a place in this repository for shared annotation configs and supporting tools.[0.4.0] - 2020-07-22Add support for multi-line code annotations[0.3.4] - 2020-05-06Removed support for Django<2.2Removed support for Python2.7 and Python3.6Added support for Python3.8[0.3.2] - 2019-06-21AddedAdd RST anchors throughout annotation report docs[0.3.1] - 2019-03-20AddedBump pyyaml to version 5.1 to address unsafe load() CVE.[0.1.0] - 2018-11-16AddedFirst release on PyPI.