Skip to main content

Build git.sr.ht annotations for Python projects

Project description

annotatepy

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

This project is in early stages of development, so things may change and break without warning.

Resources

Usage

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

https://git.sr.ht/~ihabunek/annotatepy/

Example

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for annotatepy, version 0.3.0
Filename, size File type Python version Upload date Hashes
Filename, size annotatepy-0.3.0-py3-none-any.whl (16.7 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size annotatepy-0.3.0.tar.gz (3.6 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page