Metadata-Version: 2.1
Name: code-annotations
Version: 0.10.0
Summary: Extensible tools for parsing annotations in codebases
Home-page: https://github.com/edx/code-annotations
Author: edX
Author-email: oscm@edx.org
License: AGPL 3.0
Keywords: edx pii code annotations
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Django
Classifier: Framework :: Django :: 2.2
Classifier: Intended Audience :: Developers
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.5
Classifier: Programming Language :: Python :: 3.8
Requires-Dist: Django
Requires-Dist: Jinja2
Requires-Dist: stevedore
Requires-Dist: click (<8.0,>=7.0)
Requires-Dist: python-slugify
Requires-Dist: pyyaml

code-annotations
=============================

|pypi-badge| |travis-badge| |codecov-badge| |doc-badge| |pyversions-badge|
|license-badge|

Extensible tools for parsing annotations in codebases

Overview
--------

This 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 the ``contrib`` folder.

Documentation
-------------

The full documentation is at https://code-annotations.readthedocs.org.

License
-------

The code in this repository is licensed under the AGPL 3.0 unless
otherwise noted.

Please see ``LICENSE.txt`` for details.

How To Contribute
-----------------

Contributions are very welcome.

Please read `How To Contribute <https://github.com/edx/edx-platform/blob/master/CONTRIBUTING.rst>`_ for details.

Even though they were written with ``edx-platform`` in mind, the guidelines
should be followed for Open edX code in general.

PR description template should be automatically applied if you are sending PR from github interface; otherwise you
can find it it at `PULL_REQUEST_TEMPLATE.md <https://github.com/edx/code-annotations/blob/master/.github/PULL_REQUEST_TEMPLATE.md>`_

Issue report template should be automatically applied if you are sending it from github UI as well; otherwise you
can find it at `ISSUE_TEMPLATE.md <https://github.com/edx/code-annotations/blob/master/.github/ISSUE_TEMPLATE.md>`_

Reporting Security Issues
-------------------------

Please do not report security issues in public. Please email security@edx.org.

Getting Help
------------

Have a question about this repository, or about Open edX in general?  Please
refer to this `list of resources`_ if you need any assistance.

.. _list of resources: https://open.edx.org/getting-help


.. |pypi-badge| image:: https://img.shields.io/pypi/v/code-annotations.svg
    :target: https://pypi.python.org/pypi/code-annotations/
    :alt: PyPI

.. |travis-badge| image:: https://travis-ci.org/edx/code-annotations.svg?branch=master
    :target: https://travis-ci.org/edx/code-annotations
    :alt: Travis

.. |codecov-badge| image:: http://codecov.io/github/edx/code-annotations/coverage.svg?branch=master
    :target: http://codecov.io/github/edx/code-annotations?branch=master
    :alt: Codecov

.. |doc-badge| image:: https://readthedocs.org/projects/code-annotations/badge/?version=latest
    :target: http://code-annotations.readthedocs.io/en/latest/
    :alt: Documentation

.. |pyversions-badge| image:: https://img.shields.io/pypi/pyversions/code-annotations.svg
    :target: https://pypi.python.org/pypi/code-annotations/
    :alt: Supported Python versions

.. |license-badge| image:: https://img.shields.io/github/license/edx/code-annotations.svg
    :target: https://github.com/edx/code-annotations/blob/master/LICENSE.txt
    :alt: License


Change Log
----------

..
   All enhancements and patches to code_annotations will be documented
   in this file.  It adheres to the structure of http://keepachangelog.com/ ,
   but in reStructuredText instead of Markdown (for ease of incorporation into
   Sphinx documentation and the PyPI description).

   This project adheres to Semantic Versioning (http://semver.org/).

.. There should always be an "Unreleased" section for changes pending release.

[0.10.0] - 2020-10-12
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* Fix table of contents generated by sphinx extensions


[0.9.0] - 2020-09-25
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* Get rid of the ``documented_elsewhere`` annotation, which is used nowhere


[0.8.0] - 2020-09-10
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* Add ``settings`` Sphinx extension with setting annotation configuration file

[0.7.0] - 2020-09-07
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* Simplify the feature toggle annotation format

[0.6.0] - 2020-08-27
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* Add support for multiline annotations for lines prefixed with single-line comment signs ("#")

[0.5.1] - 2020-08-25
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* Add support for warnings in the ``featuretoggles`` Sphinx extension

[0.5.0] - 2020-08-06
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* Add ``featuretoggles`` Sphinx extension
* Include ``contrib`` folder in pip-installable package
* Add 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-22
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* Add support for multi-line code annotations

[0.3.4] - 2020-05-06
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* Removed support for Django<2.2
* Removed support for Python2.7 and Python3.6
* Added support for Python3.8

[0.3.2] - 2019-06-21
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Added
_____

* Add RST anchors throughout annotation report docs


[0.3.1] - 2019-03-20
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Added
_____

* Bump pyyaml to version 5.1 to address unsafe load() CVE.


[0.1.0] - 2018-11-16
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Added
_____

* First release on PyPI.


