https://github.com/icij/fluent-http-apigen

small tool to generate HTTP API documentation for https://github.com/CodeStory/fluent-http
https://github.com/icij/fluent-http-apigen

Last synced: 13 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/icij/fluent-http-apigen
• Owner: ICIJ
• License: agpl-3.0
• Created: 2019-10-11T08:50:15.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2020-07-29T08:24:02.000Z (over 4 years ago)
• Last Synced: 2024-03-14T18:18:43.293Z (8 months ago)
• Language: Python
• Size: 29.3 KB
• Stars: 2
• Watchers: 9
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
About

=====

.. image:: https://circleci.com/gh/ICIJ/fluent-http-apigen.png?style=shield&circle-token=0d24d3ece1add1d2d22cccafd04c0b0024550a20

   :alt: Circle CI

   :target: https://circleci.com/gh/ICIJ/fluent-http-apigen

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