Features

• GET / POST / DELETE requests to communicate with BlanketDB

• JSON requests / responses

• HTML forms can POST directly to BlanketDB

• Data stored in buckets

• Schemaless

• Query using various parameters to a HTTP GET request

• Data is stored in a single file on the file system which is a SQLite database

• BlanketDB is a single Python file without any dependencies besides the standard library

• No sequrity whatsoever; BlanketDB is completely open to readers and writers (use with care!)

Quickstart

To install BlanketDB, you’ll need a Python (>=3.4) installation with pip:

$ pip install blanketdb

To use BlanketDB as a standalone database (and communicate over HTTP), enter the following command:

$ python3 -m blanketdb -i localhost -p 8080 -f /path/to/db.sqlite

BlanketDB will now serve its web interface at http://localhost:8080. You can open this page in your browser to check if everything works.

To use BlanketDB in a Python project, enter the following code:

from blanketdb import BlanketDB
db = BlanketDB('/path/to/db.sqlite')

# you can now use db using its Python API
db.store_dict(x='test')['id']
for entry in db:
    print(entry)

# db is alse a wsgi conforming callable
# you can use it e.g. with the wsgi reference implementation
from wsgiref.simple_server import make_server
httpd = make_server('localhost', 8080, db)
httpd.serve_forever()

Detailed documentation is available at https://blanketdb.readthedocs.io.

Credits

Main author and project maintainer is luphord.

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

0.4.0 (2020-02-26)

• Start uwsgi using http protocol by default in DOCKERFILE (s.t. standalone use is possible)

• Overwrite CMD in docker-compose file to communicate via uwsgi protocol between nginx and blanketdb container

0.3.4 (2020-02-26)

• Support Python 3.8

0.3.3 (2019-12-12)

• Split tests into Python and HTTP API tests

• Added tests that can be executed against an actual HTTP API of BlanketDB

0.3.2 (2019-12-04)

• Release to trigger build on dockerhub

0.3.1 (2019-03-06)

• Improved clarity with default values

0.3 (2019-03-06)

• Type annotations for BlanketDB

• Python 3.4 is not supported anymore (as it does not know type annotations)

0.2.2 (2019-01-31)

• setuptools entrypoint for cli

• quickstart documentation

• added logo

0.2.1 (2019-01-24)

• fix tag confusion

0.2.0 (2019-01-24)

• Added CLI for starting BlanketDB with wsgiref.simple_server

• Tests for BlanketDB Web API using webtest

• Added documentation for usage and Web API

0.1.0 (2019-01-18)

• First release on PyPI.