Debian Codegraph @

PKG-INFO

raw
1 Metadata-Version: 2.1
2 Name: lesana
3 Version: 0.10.1
4 Summary: Manage collection inventories throught yaml files.
5 Author-email: Elena ``of Valhalla'' Grandi <[email protected]>
6 License: AGPLv3+
7 Project-URL: Homepage, https://lesana.trueelena.org/
8 Project-URL: Documentation, https://lesana.trueelena.org/
9 Project-URL: Repository, https://git.sr.ht/~valhalla/lesana
10 Project-URL: Source, https://git.sr.ht/~valhalla/lesana
11 Project-URL: Issues, https://todo.sr.ht/~valhalla/lesana
12 Project-URL: Tracker, https://todo.sr.ht/~valhalla/lesana
13 Project-URL: Changelog, https://git.sr.ht/~valhalla/lesana/tree/master/item/CHANGELOG.rst
14 Project-URL: Mailing lists, https://sr.ht/~valhalla/lesana/lists
15 Keywords: collection,inventory
16 Classifier: Development Status :: 3 - Alpha
17 Classifier: Environment :: Console
18 Classifier: Intended Audience :: Developers
19 Classifier: Intended Audience :: End Users/Desktop
20 Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
21 Classifier: Operating System :: POSIX
22 Classifier: Programming Language :: Python :: 3
23 Classifier: Programming Language :: Python :: 3.8
24 Classifier: Programming Language :: Python :: 3.9
25 Classifier: Programming Language :: Python :: 3.10
26 Classifier: Programming Language :: Python :: 3.11
27 Classifier: Programming Language :: Python :: 3.12
28 Classifier: Topic :: Software Development :: Libraries :: Python Modules
29 Classifier: Topic :: Utilities
30 Requires-Python: >=3.8
31 Description-Content-Type: text/x-rst
32 Requires-Dist: ruamel.yaml
33 Requires-Dist: jinja2
34 Requires-Dist: python-dateutil
35 Provides-Extra: cli
36 Requires-Dist: hazwaz; extra == "cli"
37
38 ===============================
39 lesana - a collection manager
40 ===============================
41
42 lesana is a python3 library to organize collections of various kinds.
43 It is designed to have a data storage / serialization format that is
44 friendly to git and other VCSs, but decent performances.
45
46 To reach this aim it uses yaml_ as its serialization format, which is
47 easy to store in a VCS, share between people and syncronize between
48 different computers, but it also keeps an index of this data in a local
49 xapian_ database in order to allow for fast searches.
50
51 .. _yaml: http://yaml.org/
52 .. _xapian: https://xapian.org/
53
54 lesana supports collections of any kind, as long as their entries can be
55 described with a mostly flat dictionary of fields of the types described
56 in the documentation file ``field_types``.
57
58 Some example collection schemas are provided, but one big strenght of
59 lesana is the ability to customize your collection with custom fields
60 by simply writing a personalized ``settings.yaml``.
61
62 Installation
63 ------------
64
65 The recommended way to install lesana is to use the packages available
66 for your distribution; see e.g. the `list of distributions that provide
67 lesana on repology <https://repology.org/project/lesana/versions>`_.
68
69 Alternatively, the source code for lesana can be downloaded from the git
70 repository at https://git.sr.ht/~valhalla/lesana; and releases are made
71 on `pypi <https://pypi.org/project/lesana/>`_.
72
73 lesana expects to run on a POSIX-like system and requires the following
74 dependencies:
75
76 * python3
77 * xapian_
78 * `ruamel.yaml <https://bitbucket.org/ruamel/yaml>`_
79 * `jinja2 <http://jinja.pocoo.org/>`_
80 * `dateutil <https://dateutil.readthedocs.io/>`_
81 * `GitPython <https://github.com/gitpython-developers/GitPython>`_
82 optional, to add git support.
83
84 Under debian (and derivatives), the packages to install are::
85
86 apt install python3-jinja2 python3-ruamel.yaml python3-xapian \
87 python3-dateutil python3-git
88
89 lesana can be run in place from the git checkout / extracted tarball; to
90 use ``setup.py`` you will also need setuptools (e.g. from the
91 ``python3-setuptools`` package under debian and derivatives).
92
93 Contributing
94 ------------
95
96 Lesana is `hosted on sourcehut <https://sr.ht/~valhalla/lesana>`_:
97
98 * `bug tracker <https://todo.sr.ht/~valhalla/lesana>`_
99 * `mailing lists <https://sr.ht/~valhalla/lesana/lists>`_
100 * `git repository <https://sr.ht/~valhalla/lesana/sources>`_
101 * `CI <https://builds.sr.ht/~valhalla/lesana>`_
102
103 License
104 -------
105
106 Copyright (C) 2016-2024 Elena Grandi
107
108 This program is free software: you can redistribute it and/or modify it
109 under the terms of the GNU Affero General Public License as published by
110 the Free Software Foundation, either version 3 of the License, or (at
111 your option) any later version.
112
113 This program is distributed in the hope that it will be useful,
114 but WITHOUT ANY WARRANTY; without even the implied warranty of
115 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
116 GNU General Public License for more details.
117
118 You should have received a copy of the GNU Affero General Public License
119 along with this program. If not, see <http://www.gnu.org/licenses/>.