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:

• Werkzeug documentation.

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.

• Introduction
  • What Findig is
  • A word on customization
  • When to use (and not to use) Findig
• Installation
  • Supported Python versions
  • Installing the development version
  • Getting extra features
  • Getting the source code
• Quickstart
  • The tiniest JSON application
  • Adding resources
  • Collections
  • Data operations
  • Restricting HTTP Methods
  • Custom applications
• taskman — A tutorial
  • The basic application
  • Serving it up
  • Adding our data models
  • Validating data
  • Calling our API
  • Customizing error output
  • Wrapping up

API Documentation

This section contains a reference for Findig’s public API.

• Findig core modules
  • App — classes for creating WSGI callables
  • findig.content — Formatters, parsers and error handlers
  • findig.context — Request context variables
  • findig.data_model — Data access for Findig applications
  • findig.dispatcher – Low-level dispatchers for Findig applications
  • findig.resource — Classes for representing API resources
  • findig.wrappers — The Findig Request object
• Higher-level tools
  • findig.tools.counter — Hit counters for apps and resources
  • findig.tools.protector — Authorization tools
  • findig.tools.protector.scopeutil — tools for working with auth scopes
  • findig.tools.validator — Request input validators
  • Abstract classes for higher-level tools
• Added features enabled by third-party libraries
  • findig.extras.redis — Some tools that are backed by Redis
  • findig.extras.sql — Tools for working with SQLAlchemy
• General Utilities

Additional Information

Miscellaneous information that you may be looking for.

• Contributing to Findig
  • Support
  • Bug Reports
  • Patches
• Changes in Findig
  • Release 0.1.1 (not yet released)
  • Release 0.1.0 (July 18, 2015)

Use these indices to search if you can’t find what you’re looking for:

• Index
• Module Index
• Search Page