doxxie 0.1

Uncover your mypy-typed library's true public API

doxxie

doxxie is a mypy plugin that outputs the public API of a mypy-typed Python library.

installation

Install from PyPI:

pip install doxxie

or install from source:

pip install git+https://github.com/Kyle-Verhoog/doxxie.git

usage

Add doxxie to the plugins section of your mypy config:

[mypy]
plugins = doxxie

Then run mypy with an environment variable specifying which modules to include:

$ DOXXIE_INCLUDES=module mypy

A file .public_api will be output with the public API of module.

configuration

All configuration is done via environment variables.

• DOXXIE_INCLUDES: comma-separated list of modules to include in the public API
  • example: "mod1,mod2"
  • default: ""
• DOXXIE_EXCLUDES: comma-separated list of modules to exclude from the public API
  • example: "mod1.internal,mod1.vendor"
  • default: ""
• DOXXIE_OUTFILE: file to output the results
  • example: "my_public_api"
  • default: .public_api
• DOXXIE_DEBUG: enable debug logging
  • default