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 details)

Uploaded Source

Built Distribution

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

Uploaded Source

File details

Details for the file fluent-http-apigen-0.3.0.tar.gz.

File metadata

  • Download URL: fluent-http-apigen-0.3.0.tar.gz
  • Upload date:
  • Size: 3.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Python-urllib/3.6

File hashes

Hashes for fluent-http-apigen-0.3.0.tar.gz
Algorithm Hash digest
SHA256 34e414342484c3bb4552ad9a266a3b7e8ec69653ec7cd7e0982766fe83e57c11
MD5 b04d1a7e7557128f7185dbc74c246c54
BLAKE2b-256 79f7529ef49f384273071b9229ac133ab5adaab458c90d41f3772b6f652b0615

See more details on using hashes here.

File details

Details for the file fluent_http_apigen-0.3.0-py3.6.egg.

File metadata

File hashes

Hashes for fluent_http_apigen-0.3.0-py3.6.egg
Algorithm Hash digest
SHA256 8d0911733856da6d92a503dac34ba8e7745a4a41d843fdd4fb1e3c8bf669f74a
MD5 fd6585b95cb3cf5632f1ce35cabaccc3
BLAKE2b-256 69e8d33569cfd3f578381a792c611262981e52240d233db3c9287af1c86f6e6b

See more details on using hashes here.

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