Metadata-Version: 1.1
Name: haddock
Version: 0.2.3
Summary: Mini-Framework for making APIs.
Home-page: https://github.com/hawkowl/haddock
Author: HawkOwl
Author-email: hawkowl@atleastfornow.net
License: MIT
Description: Haddock
        =======
        
        Haddock is a micro-framework for creating APIs. It is both the Python code to assemble the APIs and an API description format. It uses Klein and Twisted in the back end.
        
        Haddock revolves around versions - it is designed so that you can write code for new versions of your API without disturbing old ones. You simply expand the scope of the unchanged methods, and copy a reference into your new version.
        
        Why?
        ----
        
        Because I liked the look of Praekelt's Aludel (https://github.com/praekelt/aludel) but it didn't kind of work how I thought it would. So, I wrote something similar, to play around!
        
        How do I use it?
        ----------------
        
        You need two things - the API description document, and the implementation.
        
        You can find the example description document and the example Python in the root directory. Simply run `example.py` and navigate to http://localhost:8094/v1/weather?postcode=61000&unixTimestamp=1 for a demonstration.
        
        More Detail
        -----------
        
        Check `docs/APIDescription.md` for more information on the API Description. A more complete API example can be seen in `haddock/test/betterAPI.json`.
Keywords: twisted,klein,api
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
