lesana


Namelesana JSON
Version 0.10.1 PyPI version JSON
download
home_pageNone
SummaryManage collection inventories throught yaml files.
upload_time2024-04-24 13:37:09
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseAGPLv3+
keywords collection inventory
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ===============================
 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-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/>.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "lesana",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "collection, inventory",
    "author": null,
    "author_email": "Elena ``of Valhalla'' Grandi <valhalla@trueelena.org>",
    "download_url": "https://files.pythonhosted.org/packages/e0/77/509739c4e34fc04772b5a6cf0f7cad873d24520dac97f029d95f45f00825/lesana-0.10.1.tar.gz",
    "platform": null,
    "description": "===============================\n lesana - a collection manager\n===============================\n\nlesana is a python3 library to organize collections of various kinds.\nIt is designed to have a data storage / serialization format that is\nfriendly to git and other VCSs, but decent performances.\n\nTo reach this aim it uses yaml_ as its serialization format, which is\neasy to store in a VCS, share between people and syncronize between\ndifferent computers, but it also keeps an index of this data in a local\nxapian_ database in order to allow for fast searches.\n\n.. _yaml: http://yaml.org/\n.. _xapian: https://xapian.org/\n\nlesana supports collections of any kind, as long as their entries can be\ndescribed with a mostly flat dictionary of fields of the types described\nin the documentation file ``field_types``.\n\nSome example collection schemas are provided, but one big strenght of\nlesana is the ability to customize your collection with custom fields\nby simply writing a personalized ``settings.yaml``.\n\nInstallation\n------------\n\nThe recommended way to install lesana is to use the packages available\nfor your distribution; see e.g. the `list of distributions that provide\nlesana on repology <https://repology.org/project/lesana/versions>`_.\n\nAlternatively, the source code for lesana can be downloaded from the git\nrepository at https://git.sr.ht/~valhalla/lesana; and releases are made\non `pypi <https://pypi.org/project/lesana/>`_.\n\nlesana expects to run on a POSIX-like system and requires the following\ndependencies:\n\n* python3\n* xapian_\n* `ruamel.yaml <https://bitbucket.org/ruamel/yaml>`_\n* `jinja2 <http://jinja.pocoo.org/>`_\n* `dateutil <https://dateutil.readthedocs.io/>`_\n* `GitPython <https://github.com/gitpython-developers/GitPython>`_\n  optional, to add git support.\n\nUnder debian (and derivatives), the packages to install are::\n\n   apt install python3-jinja2 python3-ruamel.yaml python3-xapian \\\n               python3-dateutil python3-git\n\nlesana can be run in place from the git checkout / extracted tarball; to\nuse ``setup.py`` you will also need setuptools (e.g. from the\n``python3-setuptools`` package under debian and derivatives).\n\nContributing\n------------\n\nLesana is `hosted on sourcehut <https://sr.ht/~valhalla/lesana>`_:\n\n* `bug tracker <https://todo.sr.ht/~valhalla/lesana>`_\n* `mailing lists <https://sr.ht/~valhalla/lesana/lists>`_\n* `git repository <https://sr.ht/~valhalla/lesana/sources>`_\n* `CI <https://builds.sr.ht/~valhalla/lesana>`_\n\nLicense\n-------\n\nCopyright (C) 2016-2024 Elena Grandi\n\nThis program is free software: you can redistribute it and/or modify it\nunder the terms of the GNU Affero General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or (at\nyour option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\nGNU General Public License for more details.\n\nYou should have received a copy of the GNU Affero General Public License\nalong with this program.  If not, see <http://www.gnu.org/licenses/>.\n",
    "bugtrack_url": null,
    "license": "AGPLv3+",
    "summary": "Manage collection inventories throught yaml files.",
    "version": "0.10.1",
    "project_urls": {
        "Changelog": "https://git.sr.ht/~valhalla/lesana/tree/master/item/CHANGELOG.rst",
        "Documentation": "https://lesana.trueelena.org/",
        "Homepage": "https://lesana.trueelena.org/",
        "Issues": "https://todo.sr.ht/~valhalla/lesana",
        "Mailing lists": "https://sr.ht/~valhalla/lesana/lists",
        "Repository": "https://git.sr.ht/~valhalla/lesana",
        "Source": "https://git.sr.ht/~valhalla/lesana",
        "Tracker": "https://todo.sr.ht/~valhalla/lesana"
    },
    "split_keywords": [
        "collection",
        " inventory"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2ec8453a68471d68df43e31efbeb6923b2f14ef3431ec75437ec72b912597239",
                "md5": "31cd237274d082bba32705a2c1dbde80",
                "sha256": "8e5d220aa5cdeb246c58d68af38d1598da50faf9f56ece646ad367c10349cec2"
            },
            "downloads": -1,
            "filename": "lesana-0.10.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "31cd237274d082bba32705a2c1dbde80",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 16784,
            "upload_time": "2024-04-24T13:37:08",
            "upload_time_iso_8601": "2024-04-24T13:37:08.375814Z",
            "url": "https://files.pythonhosted.org/packages/2e/c8/453a68471d68df43e31efbeb6923b2f14ef3431ec75437ec72b912597239/lesana-0.10.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e077509739c4e34fc04772b5a6cf0f7cad873d24520dac97f029d95f45f00825",
                "md5": "d4d91e7e85c7ff8436b6dfeeb28aa040",
                "sha256": "7be10f6afef5571a6528d733f4d4d3dd542a73e7687048cb020710b96d37be8a"
            },
            "downloads": -1,
            "filename": "lesana-0.10.1.tar.gz",
            "has_sig": false,
            "md5_digest": "d4d91e7e85c7ff8436b6dfeeb28aa040",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 61887,
            "upload_time": "2024-04-24T13:37:09",
            "upload_time_iso_8601": "2024-04-24T13:37:09.968042Z",
            "url": "https://files.pythonhosted.org/packages/e0/77/509739c4e34fc04772b5a6cf0f7cad873d24520dac97f029d95f45f00825/lesana-0.10.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-24 13:37:09",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "lesana"
}
        
Elapsed time: 0.24834s