Welcome to Findig’s documentation!¶
Findig is a micro-framework for developing HTTP applications in Python. It is built on Werkzeug and is intended as an alternative to Flask when developing RESTful APIs.
The documentation is split into two parts: the user guide (which includes installation and quickstart instructions) and detailed API documentation.
Note
The documentation here isn’t complete yet. If you stumble across something that you think should be documented, but isn’t, please feel free to let us know about it on our issue tracker.
You may also clone the Github Repository and submit pull requests with documentation fixes for review.
Findig uses Werkzeug internally, and so some understanding of how Werkzeug works and its data types, while not necessary, will almost certainly be helpful:
User Guide¶
This part of the documentation is a comprehensive guide for getting things done with Findig, as well as some notes on its design.
API Documentation¶
This section isn’t ready yet. Please check back later.
- Findig core modules
- App — classes for creating WSGI callables
findig.content— Formatters, parsers and error handlersfindig.context— Request context variablesfindig.data_model— Data access for Findig applicationsfindig.dispatcher– Low-level dispatchers for Findig applicationsfindig.resource— Classes for representing API resourcesfindig.wrappers— The Findig Request object
- Higher-level tools
- Added features enabled by third-party libraries
- General Utilities