aboutsummaryrefslogtreecommitdiff

lesana - a collection manager

lesana is a python3 library to organize collections of various kinds. It is 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.

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.

Installation

lesana expects to run on a POSIX-like system and requires the following dependencies:

Under debian (and derivatives), the packages to install are:

apt install python3-guacamole python3-jinja2 python3-ruamel.yaml \
python3-xapian python3-git

(some of those are only available on stretch+ because earlier versions lacked python3 support.)

lesana can be run in place from the git checkout / extracted tarball; to use setup.py you will also need setuptools (e.g. from the python3-setuptools package under debian and derivatives).

License

Copyright (C) 2016-2017 Elena Grandi

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.