Metadata-Version: 2.1
Name: calibrestekje
Version: 0.0.1
Summary: Library prototyping based on Calibre.
Home-page: https://github.com/decentral1se/calibrestekje
Author: decentral1se
Author-email: lukewm@riseup.net
Maintainer: decentral1se
Maintainer-email: lukewm@riseup.net
License: GPLv3
Project-URL: Source Code, https://github.com/decentral1se/calibrestekje
Project-URL: Documentation, https://calibrestekje.readthedocs.io/
Project-URL: Maintainer Support, https://liberapay.com/decentral1se/
Description: .. _header:
        
        *************
        calibrestekje
        *************
        
        .. image:: https://img.shields.io/badge/license-GPL-brightgreen.svg
           :target: LICENSE
           :alt: Repository license
        
        .. image:: https://badge.fury.io/py/calibrestekje.svg
           :target: https://badge.fury.io/py/calibrestekje
           :alt: PyPI package
        
        .. image:: https://travis-ci.com/decentral1se/calibrestekje.svg?branch=master
           :target: https://travis-ci.com/decentral1se/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
        ------------------------------------
        
        Calibrestekje is a Python library which provides a way to work with the
        `Calibre`_ database outside the context of the Calibre desktop and web
        interfaces. A set of generated `SQLAlchemy`_ bindings (see `sqlacodegen`_ for
        more) are provided which allow for the read/write access to an existing Calibre
        metadata database (a file typically called ``metadata.db``). These bindings are
        more fine grained than Calibres `database interface`_ and provide direct access
        to the Database table layer.
        
        .. _Calibre: https://calibre-ebook.com/
        .. _SQLALchemy: https://docs.sqlalchemy.org/
        .. _sqlacodegen: https://github.com/agronholm/sqlacodegen
        .. _database interface: https://manual.calibre-ebook.com/db_api.html
        .. _Relearn!: http://relearn.be/2019/
        
        .. _example:
        
        Quick Example
        *************
        
        See documentation linked below for more.
        
        .. code-block:: python
        
            from calibrestekje import Book, Publisher, init_session
        
            session = init_session("sqlite:///mymetadata.db")
        
            publisher = (session.query(Publisher)
                                .filter(Publisher.name == "MIT Press").one())
        
            books = (session.query(Book)
                            .filter(Book.publishers.contains(publisher)))
        
            print(f"Books published by MIT Press: {books.count()}")
        
        .. _documentation:
        
        Documentation
        *************
        
        * https://calibrestekje.readthedocs.io/
        
        Mirroring
        *********
        
        * `hack.decentral1.se/decentral1se/calibrestekje`_
        
        .. _hack.decentral1.se/decentral1se/calibrestekje: https://hack.decentral1.se/decentral1se/calibrestekje/
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.6
Provides-Extra: docs
Provides-Extra: changelog
