Skip to main content

A framework for writing HTTP service APIs

Project description

# woodstove

[![Build Status](https://travis-ci.org/richardmarshall/woodstove.svg?branch=master)](https://travis-ci.org/richardmarshall/woodstove) [![PyPi](https://img.shields.io/pypi/v/woodstove.svg)](https://pypi.python.org/pypi/woodstove)

A simple [python](https://python.org) framework for building json http apis built ontop of the [bottle](http://bottlepy.org) microframework.

## Install

```
pip install woodstove
```

## Usage

### Example: Hello world

```python
from woodstove import app, server

class Hello(object):
wsapp = app.App('/hello')

@wsapp.get('/world')
def hello_world(self):
return "Hi!"

s = server.Server()
s.mount(Hello())
s.run(host='localhost', port=8080)
```

Run this script then point curl or your browser at http://localhost:8080/hello/world.

```
$ curl http://localhost:8080/hello/world
{"total": 1, "data": ["Hi!"]}
```

## Testing

TODO

## Contributing

See [CONTRIBUTING](CONTRIBUTING.md) for details on submitting patches.

## Licensing

Woodstove is licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE) for full license text.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for woodstove, version 0.1.1
Filename, size File type Python version Upload date Hashes
Filename, size woodstove-0.1.1-py2-none-any.whl (20.1 kB) File type Wheel Python version py2 Upload date Hashes View
Filename, size woodstove-0.1.1-py3-none-any.whl (20.1 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size woodstove-0.1.1.tar.gz (15.3 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page