Skip to main content

A man is not dead while his name is still spoken.

Project description

Flask-Clacks

https://img.shields.io/pypi/v/flask-clacks.svg https://img.shields.io/travis/WilliamMayor/flask-clacks.svg Documentation Status

A man is not dead while his name is still spoken.

This is a very simple Flask extension that adds ‘X-Clacks-Overhead’ headers to your website’s responses.

Features

This package exposes a Flask extension which by default adds the header X-Clacks-Overhead: GNU Terry Pratchett on all routes, for all origins and methods.

  • You can add extra names to your overhead

  • You can decorate individual routes to have the overhead

Installation

Install the extension with using pip, or easy_install.

$ pip install -U flask-clacks

Usage

Apply to all routes, sending only Terry Pratchett’s name in the overhead.

from flask import Flask
from flask-clacks import Clacks

app = Flask(__name__)
Clacks(app)

@app.route("/")
def index():
    # Will have the header added to the response
    return "OK"

Apply to all routes, sending Terry Pratchett and John Dearheart’s names in the overhead.

from flask import Flask
from flask-clacks import Clacks

app = Flask(__name__)
Clacks(app, names=('John Dearheart', ))

@app.route("/")
def index():
    # Will have the the clacks overhead header for both Terry and John
    return "OK"

Apply to specific routes, sending different names back on different responses.

from flask import Flask
from flask-clacks import clacks

app = Flask(__name__)

@app.route("/terry/")
@clacks
def terry():
    # Will have a clacks overhead header for Terry
    return "OK"

@app.route("/terry-and-john/")
@clacks(names=('John Dearheart', ))
def terry_and_john():
    # Will have a clacks overhead header for both Terry and John
    return "OK"

@app.route("/no-one/")
def no_one():
    # Will not have clacks overhead headers
    return "OK"

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

Thanks go to the Flask-CORS extension for providing decent examples of how to package an extension.

History

1.0.0 (2017-04-26)

  • First release on PyPI.

1.0.1 (2017-04-26)

  • Learning how things like travis, PyPI, and tox work

  • Fixing small config things

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

flask-clacks-1.0.1.tar.gz (12.8 kB view details)

Uploaded Source

Built Distribution

flask_clacks-1.0.1-py2.py3-none-any.whl (5.1 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file flask-clacks-1.0.1.tar.gz.

File metadata

File hashes

Hashes for flask-clacks-1.0.1.tar.gz
Algorithm Hash digest
SHA256 2468f8e870749a382be220baf5407c68f9c51c8b7bf5f37fbc76a17fc531e432
MD5 5d28d56d2e3cd6d43fdd0b4df3c7d528
BLAKE2b-256 1e6f59882c14441241b0b0f738db5f6e9e0945e6f3d74cf25312fe387d1ff9d7

See more details on using hashes here.

File details

Details for the file flask_clacks-1.0.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for flask_clacks-1.0.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ed641435a22c7a9f3034123437a1d37fc275c20d4f0a0bdfb53bfcf3bc0a8e59
MD5 a4e18c9a97730ddcf776522fbe2d8ac4
BLAKE2b-256 8d65117c0786cf589c9fc58fb145d02099ebc667769b8ec3cd82e69750fe2f0c

See more details on using hashes here.

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