aboutsummaryrefslogtreecommitdiff
path: root/README.rst
blob: 648ed194906e7bfb6ed2e6d9cd96daa8513e324a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
===============================
 lesana - a collection manager
===============================

lesana is a python3 library to organize collections of various kinds
designed to have a data storage / serialization format that is friendly
to git and other VCSs, but decent performances.

To reach this aim it uses yaml_ as its serialization format, which is
easy to store in a VCS, share between people and syncronize between
different computers, but it also keeps an index of this data in a local
xapian_ database in order to allow for fast searches.

.. _yaml: http://yaml.org/
.. _xapian: https://xapian.org/

lesana supports collections of any kind, as long as their entries can be
described with a mostly flat dictionary of fields of the types described
in the documentation file ``field_types``.

Some example collection schemas are provided, but one big strenght of
lesana is the ability to customize your collection with custom fields
either by simply writing a personalize schema.yaml or, in more complex
cases, by inheriting from it in another module.