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 <java_source_files>

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.

Source Distribution

fluent-http-apigen-0.3.0.tar.gz (3.9 kB view hashes)

Uploaded Source

Built Distribution

fluent_http_apigen-0.3.0-py3.6.egg (9.1 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page