Skip to main content
# pyabp
[API Blueprint](https://apiblueprint.org/) from python docstring.

# Getting started
```
pip install pyabp
```

# Usage
```
usage: pyabp [-h] [-w [NAME [NAME ...]]] [--host HOST]

API Blueprint from python docstring.

optional arguments:
-h, --help show this help message and exit
-w [NAME [NAME ...]], --write [NAME [NAME ...]]
Write out the API Blueprint documentation for a module
to a file in the current directory. If <name> contains
a '/', it is treated as a filename; if it names a
directory, documentation is written for all the
contents.
--host HOST Your host server address.
```

# Examples
```
pyabp -w /path/to/pyabp/examples/ --host https://polls.apiblueprint.org/
```

# Resources
[API Blueprint Tutorial](https://apiblueprint.org/documentation/tutorial.html)

# License
[MIT License](LICENSE)

Metadata

Release history Release notifications | RSS feed

This release

0.1.3 This release

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page