# 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 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.

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.

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

- python3

- xapian

- ruamel.yaml

- jinja2

- dateutil

- 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:

- bug tracker

- mailing lists

- git repository

- CI

## License

Copyright (C) 2016-2024 Elena Grandi

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero 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 Affero General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

## Documentation

The documentation for the latest development version of lesana can be browsed online at https://lesana.trueelena.org; PDF and epub versions are also available [1].

[1]

Everything is also available via onion, at http://aublvconhsld6cvcf3dbibffzih2un5bicp3s3b5qmkskof26p3pssqd.onion/

The author can be contacted via email: webmaster AT trueelena DOT org.

## Contents

Contents:

- User Documentation
  - Getting Started (Command Line)
  - The settings file
  - Search syntax
  - Moving Data between Collections
  - lesana derivatives
- Developer Documentation
  - Promises
- Contributor Documentation
  - Release procedure
- Man Pages
  - lesana-edit
  - lesana-export
  - lesana-index
  - lesana-init
  - lesana-new
  - lesana-rm
  - lesana
  - lesana-search
  - lesana-get-values
  - lesana-show
- lesana reference
  - lesana package

## Indices and tables

- Index

- Module Index

- Search Page