Easily create Heroku addons in Flask.
* author: Randall Degges
* email: email@example.com
* status: maintained, in development
So, you use [Heroku](http://www.heroku.com/) to host your Flask apps. You like
the [addons](http://addons.heroku.com/) and you feel good, but your favorite
(API / service / tool / whatever) doesn't yet have an addon, and that makes you
- You: "I thought the cloud was supposed to have *everything*! (grumble)"
- You: "I know! I'll make my own addon! I'll even get rich in the process!"
So you google "How can I create a Heroku addon?" and find the official
[docs](https://addons.heroku.com/provider) but you're intimidated.
- You: "There's too much stuff to do. I give up. (grumble)"
- You: "I hate *the cloud* :("
**Don't feel bad! Stop whining!**
I've got you covered.
`flask-samurai` basically makes building Heroku addons in Flask easier than it
already is, and probably easier than it even should be. If you've ever wanted
to make a Heroku addon, but didn't feel like doing a lot of work,
`flask-samurai` is probably just the thing you need.
Among other things, `flask-samurai` will:
- Handle all Heroku API call authentication.
- Run local tests against your Heroku API calls to make sure you didn't fuck
- Make adding / removing / changing Heroku addon users insanely easy.
From the command line, run `pip install -U flask-samurai`. If you don't have
`pip` installed, and you're on Ubuntu (or Debian), try running `sudo apt-get -y
install python-pip` first.
Next, you need to add two settings to your Flask configuration:
# flask-samurai settings:
SAMURAI_USERNAME = 'myaddonname'
SAMURAI_PASSWORD = 'somelongpassword'
Those two settings should be identical to what you've defined in your
`addon-manifest.json` file that Heroku requires you to generate. If you have no
idea what the hell I'm talking about, [read
If you don't know how to configure your Flask app, you should probably [read
Right now, there's only a single decorator to help you do stuff: `heroku`. This
decorator basically lets you wrap a Flask view, and ensures that all incoming
HTTP requests are coming from Heroku directly.
To use it, do the following:
from flask import Flask
from samurai.decorators import Heroku
app = Flask(__name__)
"""This view will return a 401 if the request is NOT originated by Heroku."""
Make sure that the `@heroku` decorator goes beneath the `@app` decorator, as
TODO: Brief introduction on what you do with files - including link to relevant help section.