Skip to main content

Sticker is the glue between Python functions and your API design.

Project description

<p align="center">
<img height="100" src="" alt="Sticker Logo">

> Sticker is the glue between Python functions and your API design.

Let your Python functions automatically become your API handlers. Sticker allows you to choose Flask,,
Sanic, or Tornado as your application runtime.

Key features:
- Community created and maintained
- Support for [__OpenAPI 3.0__](
- Multi-framework support:
- Support for __pure Python handlers__ (no boilerplate code)

### It's Easy to Write:

You need a little bit of Python.

# filename:

def say_hello(params):
return {"contents": "Hello World!"}

Plus bits of your API description.

# filename: hello.yml
openapi: "3.0.0"
operationId: hello.say_hello

Now the fun part, you choose which web framework you want to use.

Run with Flask:
from sticker import FlaskAPI
api = FlaskAPI('hello.yml')

Run with
from sticker import BottleAPI
api = BottleAPI('hello.yml')

Run with Sanic:
from sticker import SanicAPI
api = SanicAPI('hello.yml')

Run with Tornado:
from sticker import TornadoAPI
import tornado.ioloop
api = TornadoAPI('hello.yml')

The framework setup, validation, types conversion, and mocking is handled at runtime by Sticker.

# Installation

Sticker is published at PyPI, so you can use `pip` to install:

pip install sticker

# Requirements

Sticker was developed for __Python >=3.6__ and __OpenAPI 3.0__. Support for Python 2.7 is not present nor planned for this project.

# Documentation

Sticker is a flexible metaframework for Web API development and execution. The OpenAPI 3.0 standard is used as
description format for Sticker powered APIs. You provide the API specification and choose one of the
Sticker's runtimes to have a webserver up and running.

In this document we will describe a few different ways to write code that works well with Sticker.

## Pure Python Handlers

Sticker supports the use of pure Python functions as handlers. Your code will be free of any framework
specific boilerplate code. This allows you to swap between different frameworks as you wish. Sticker will
take care of putting together your code, your API, and the framework you choose.

def myhandler(params):
return {
"content": f"Hello {params.get("name", "World")}!",
"status_code": 200

Writing tests for pure Python handles is easy and also
free of boilerplate code.

def test_myhandler():
params = {
"name": "John Doe"
response = myhandler(params)
assert response["content"] == "Hello John Doe!"

## Error Handling

Sticker expects you to define the error format to be returned by your API. A error handler is configurable,
and called every time validation for the endpoint fails.

def error_handler(error):
return {
"content": {
"error": error["message"]
"headers": {
"Content-Type": "application/json"
"status_code": 400

Project details

Download files

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

Source Distribution

sticker-0.0.1.tar.gz (8.6 kB view hashes)

Uploaded Source

Built Distribution

sticker-0.0.1-py2.py3-none-any.whl (5.9 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page