Skip to main content

App generate HTTP documentation from fluent-http code

Project description

Circle CI

This is a small tool to generate HTTP API documentation for https://github.com/CodeStory/fluent-http

It generates markdown and provides API documentation like https://github.com/ICIJ/datashare/wiki/Datashare-API

Use

Install with pip

pip install fluent-http-apigen
apigen ...

Develop

To develop, just run:

virtualenv --python=python3 venv
source venv/bin/activate
python setup.py develop
pip install -e ".[dev]"
nosetests

To release

bumpversion --commit --tag --current-version `python setup.py --version` [major|minor|patch] setup.py
git push origin master --tags
python setup.py  sdist bdist_egg upload

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 fluent-http-apigen, version 0.2.0
Filename, size File type Python version Upload date Hashes
Filename, size fluent_http_apigen-0.2.0-py3.6.egg (8.9 kB) File type Egg Python version 3.6 Upload date Hashes View hashes
Filename, size fluent-http-apigen-0.2.0.tar.gz (3.8 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 DigiCert DigiCert EV certificate StatusPage StatusPage Status page