Metadata-Version: 1.1
Name: apihero
Version: 0.1.3
Summary: RESTful JSON API documentation generator tool with live unit test.
Home-page: http://github.com/meyt/apihero
Author: Mahdi Ghane.g
Author-email: UNKNOWN
License: GPLv3
Description: 
        
        .. image:: https://github.com/meyt/apihero/raw/master/apihero-logo-128.png
        
        =======
        APIHero
        =======
        
        RESTful JSON API documentation generator tool with live unit test. `Demo <https://meyt.github.io/apihero-demo/build/index.html>`_
        
        - Live test unit.
        - File based structure.
        - Template support (Based on `Mako <http://www.makotemplates.org/>`_).
        - Formatting with JSON and Markdown.
        
        
        How to use
        ==========
        
        install from pip:
        
            sudo pip install apihero
        
        just work on python3, and if doesn't work on distros like ubuntu
        ::
        
            sudo apt install python3-pip
            sudo pip3 install apihero
        
        
        Now checkout `APIHero sample <https://github.com/meyt/apihero-demo/>`_ and learn how to create your own documentation.
        for build output `cd` on your documentation directory and simply run `apihero`.
        
        
        
        TODO
        ====
        
        - Localization support.
        - Be template design easier.
        - External pages.
        - Search.
        - Response syntax highlighting.
        - Single-page build.
        - Add remember option for parameters, to keep last value.
        - Pre-loader for test unit.
        - Complete APIHero documentation.
        - Add configurable CLI argument's.
        - Add one level category.
Keywords: apihero api_documentation api document_generator
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Build Tools
