1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
|
===============================
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.
.. _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
by simply writing a personalized ``settings.yaml``.
Installation
------------
The recommended way to install lesana is to use the packages available
for your distribution; see e.g. the `list of distributions that provide
lesana on repology <https://repology.org/project/lesana/versions>`_.
Alternatively, the source code for lesana can be downloaded from the git
repository at https://git.sr.ht/~valhalla/lesana; and releases are made
on `pypi <https://pypi.org/project/lesana/>`_.
lesana expects to run on a POSIX-like system and requires the following
dependencies:
* python3
* xapian_
* `ruamel.yaml <https://bitbucket.org/ruamel/yaml>`_
* `jinja2 <http://jinja.pocoo.org/>`_
* `dateutil <https://dateutil.readthedocs.io/>`_
* `GitPython <https://github.com/gitpython-developers/GitPython>`_
optional, to add git support.
Under debian (and derivatives), the packages to install are::
apt install python3-jinja2 python3-ruamel.yaml python3-xapian \
python3-dateutil python3-git
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).
Contributing
------------
Lesana is `hosted on sourcehut <https://sr.ht/~valhalla/lesana>`_:
* `bug tracker <https://todo.sr.ht/~valhalla/lesana>`_
* `mailing lists <https://sr.ht/~valhalla/lesana/lists>`_
* `git repository <https://sr.ht/~valhalla/lesana/sources>`_
* `CI <https://builds.sr.ht/~valhalla/lesana>`_
License
-------
Copyright (C) 2016-2021 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/>.
|
