Build sourcehut JSON annotations for Python projects
Add deprecation notice
Add dev requirements file
Switch order of checks



You can also use your local clone with git send-email.


Scans Python source code and emits an annotation graph for git.sr.ht's code annotations feature.

This project no longer maintained since Sourcehut dropped support for annotations.



annotatepy [-h] [-o OUTPUT] [-r ROOT] [source_paths [source_paths ...]]

Generate sourcehut annotations

positional arguments:
  source_paths          one or more paths within the project containing the
                        code to be annotated (defaults to project root)

optional arguments:
  -h, --help            show this help message and exit
  -r ROOT, --root ROOT  project root (defaults to working dir)
  -v, --verbose         enable verbose logging
  -q, --quiet           disable logging
  -i INDENT, --indent INDENT
                        if set to a non negative integer, JSON elements will
                        be pretty printed with that indent level



To annotate the code in the src and test dirs within your project and upload the annotations to sourcehut, from the project root run:

annotatepy src test > annotations.json

See docs on uploading the generated annotations to your sourcehut project here.