Giter VIP home page Giter VIP logo

fluent-http-apigen's Introduction

About

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

fluent-http-apigen's People

Contributors

bamthomas avatar sabrinadz avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.