Library prototyping based on Calibre with Flask
Go to file
Luke Murphy 5c1623a32f
Get CI passing
2020-03-01 01:49:43 +00:00
changelog Add changelog entry 2020-03-01 01:45:18 +00:00
flask_calibrestekje Get CI passing 2020-03-01 01:49:43 +00:00
test Get CI passing 2020-03-01 01:49:43 +00:00
.gitignore Bootstrap flask-calibrestekje 2020-03-01 00:57:33 +00:00
.readthedocs.yml Bootstrap flask-calibrestekje 2020-03-01 00:57:33 +00:00
.travis.yml Remove docs build 2020-03-01 01:42:36 +00:00
CHANGELOG.rst Bootstrap flask-calibrestekje 2020-03-01 00:57:33 +00:00
CODE_OF_CONDUCT.rst Bootstrap flask-calibrestekje 2020-03-01 00:57:33 +00:00
CONTRIBUTING.rst Bootstrap flask-calibrestekje 2020-03-01 00:57:33 +00:00
LICENSE Bootstrap flask-calibrestekje 2020-03-01 00:57:33 +00:00
MANIFEST.in Bootstrap flask-calibrestekje 2020-03-01 00:57:33 +00:00
README.rst Shape up README 2020-03-01 01:42:45 +00:00
mypy.ini Bootstrap flask-calibrestekje 2020-03-01 00:57:33 +00:00
pyproject.toml Get CI passing 2020-03-01 01:49:43 +00:00
setup.cfg Add dependencies 2020-03-01 01:38:37 +00:00
setup.py Bootstrap flask-calibrestekje 2020-03-01 00:57:33 +00:00
tox.ini Get CI passing 2020-03-01 01:49:43 +00:00

README.rst

.. _header:

*******************
flask-calibrestekje
*******************

.. image:: https://img.shields.io/badge/license-GPL-brightgreen.svg
   :target: LICENSE
   :alt: Repository license

.. image:: https://badge.fury.io/py/flask-calibrestekje.svg
   :target: https://badge.fury.io/py/flask-calibrestekje
   :alt: PyPI package

.. image:: https://travis-ci.com/decentral1se/flask-calibrestekje.svg?branch=master
   :target: https://travis-ci.com/decentral1se/flask-calibrestekje
   :alt: Travis CI result

.. image:: https://readthedocs.org/projects/calibrestekje/badge/?version=latest
   :target: https://calibrestekje.readthedocs.io/en/latest/
   :alt: Documentation status

.. image:: http://img.shields.io/liberapay/patrons/decentral1se.svg?logo=liberapay
   :target: https://liberapay.com/decentral1se
   :alt: Support badge

.. _introduction:

Library prototyping based on Calibre with Flask
-----------------------------------------------

.. _example:

Example
*******

.. code-block:: python

    from calibrestekje import Book
    from flask import Flask, jsonify

    from flask_calibrestekje import CalibreStekje

    app = Flask(__name__)
    app.config.from_pyfile("config.cfg")
    db = CalibreStekje(app)

    @app.route("/")
    def home():
        return jsonify({"book-count": db.session.query(Book).count()})

.. _documentation:

Documentation
*************

* https://calibrestekje.readthedocs.io/