~shakna/bottlepratchett

A middleware for Bottle that provides GNU Terry Pratchett
Add pip instructions
Minor fix to setup.py dependencies
First version

clone

read-only
https://git.sr.ht/~shakna/bottlepratchett
read/write
git@git.sr.ht:~shakna/bottlepratchett

You can also use your local clone with git send-email.

#bottlepratchett

A very simple middleware that provides GNU Terry Pratchett.


#Install

Easiest with pip:

pip install botttlepratchett

However, you can grab the file bottlepratchett directly from the repository.


#About

In one of Terry Pratchett's novels, he proposes three things, that following his death, so more technically inclined fans have grabbed onto.

  1. The clacks
  2. The GNU instruction to the clacks (G: Send message on, N: Do not log the message, U: At the end of the line, send the message back again)
  3. "A man is not dead while his name is still spoken."

So, in that friendly spirit...

A header, applied to all connections, ('X-Clacks-Overhead': 'GNU Terry Pratchett'), so that he may never be forgotten.


This plugin designed for Bottle gives you just that.

import bottle
import bottlepratchett

bottle.install(bottlepratchett.wrap)

@bottle.get('/')
def index():
    return 'Hello'

bottle.run()

Once you've installed the plugin with bottle.install it should become available on every new call to your route. (Bottle plugins are installed on the first call per route, and then cached.)

So... If we were to use curl, we could get:

> curl -I localhost:8080
HTTP/1.0 200 OK
Date: Wed, 23 Jan 2019 01:55:00 GMT
Server: WSGIServer/0.2 CPython/3.7.2
X-Clacks-Overhead: GNU Terry Pratchett
Content-Length: 5
Content-Type: text/html; charset=UTF-8

Our header has been successfully installed.


#License

Copyright 2019, James Milne

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

  3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.