decentral1se
/
calibrestekje
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Another pass on the README

This commit is contained in:
Luke Murphy 2020-02-29 23:48:38 +00:00
parent 26284877be
commit 14a0a7cb03
No known key found for this signature in database
GPG Key ID: 5E2EF5A63E3718CC
1 changed files with 10 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.rst
View File

@ -30,32 +30,25 @@ Library prototyping based on Calibre
------------------------------------ ------------------------------------
Calibrestekje is a Python library which provides a way to work with the Calibrestekje is a Python library which provides a way to work with the
`Calibre`_ metadata database outside the context of the Calibre desktop and web `Calibre`_ database outside the context of the Calibre desktop and web
interfaces. A set of generated `SQLAlchemy`_ bindings (see `sqlacodegen`_ for interfaces. A set of generated `SQLAlchemy`_ bindings (see `sqlacodegen`_ for
more) are provided which allow for the querying of an existing Calibre metadata more) are provided which allow for the read/write access to an existing Calibre
database (a file typically called ``metadata.db``). These bindings are more metadata database (a file typically called ``metadata.db``). These bindings are
fine grained than Calibres `database interface`_ and provide access to the more fine grained than Calibres `database interface`_ and provide direct access
Database table layer. to the Database table layer.
The idea of a "stekje" (Dutch word meaning "little graft") in the context of
software came out of the discussions at `Relearn`_ around cutting, grafting,
remixing, re-using and misusing software for collective work.
This stekje can be understood as a low level building block for experimenting
with new ways of doing library software. One exciting part about a stekje is
that it is possible that new roots will appear. It is hoped that Calibrestekje
may help new library software take root.
.. _Calibre: https://calibre-ebook.com/ .. _Calibre: https://calibre-ebook.com/
.. _SQLALchemy: https://docs.sqlalchemy.org/ .. _SQLALchemy: https://docs.sqlalchemy.org/
.. _sqlacodegen: https://github.com/agronholm/sqlacodegen .. _sqlacodegen: https://github.com/agronholm/sqlacodegen
.. _database interface: https://manual.calibre-ebook.com/db_api.html .. _database interface: https://manual.calibre-ebook.com/db_api.html
.. _Relearn: http://relearn.be/2019/ .. _Relearn!: http://relearn.be/2019/
.. _example: .. _example:
Example Quick Example
******* *************
See documentation linked below for more.
.. code-block:: python .. code-block:: python