Skip to content

Extensible tools for parsing annotations in codebases, powers edx PII checker.

License

Notifications You must be signed in to change notification settings

openedx/code-annotations

Folders and files

NameName
Last commit message
Last commit date

Latest commit

2d4ce49 · Apr 14, 2025
Apr 8, 2025
Apr 8, 2025
Feb 28, 2025
Apr 14, 2025
Nov 16, 2018
Dec 20, 2024
Sep 10, 2022
Jan 10, 2019
Dec 11, 2018
Nov 20, 2024
Jan 15, 2025
Jan 31, 2019
Dec 19, 2024
Apr 2, 2024
Jan 31, 2019
Dec 19, 2024
Nov 19, 2024
Nov 16, 2018
Aug 21, 2020
Nov 20, 2024
Nov 20, 2024
Nov 28, 2018
Apr 8, 2025
Apr 8, 2025

code-annotations

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 Apache Software License 2.0 unless otherwise noted.

Please see LICENSE.txt for details.

How To Contribute

Contributions are very welcome.

Please read How To Contribute for details.

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

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

Reporting Security Issues

Please do not report security issues in public. Please email security@openedx.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.