Haddock Documentation

Haddock Documentation

Release 0.6.0 HawkOwl

December 28, 2013

Contents

1 Going Fishing, or - An Introduction

3

1.1 Introduction - Getting Off The Ground . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

1.2 Introduction - Adding Global State with Service Classes . . . . . . . . . . . . . . . . . . . . . . . . 6

1.3 Introduction - Parameter Checking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

1.4 Introduction - Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

2 Specifications

15

2.1 Haddock API Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

i

ii

Haddock Documentation, Release 0.6.0

Haddock is a framework for easily creating APIs. It uses Python and Twisted, and supports both CPython 2.7 and PyPy. 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. You can get the MIT-licensed code on GitHub, or download it from PyPI.

Contents

1

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download