././@PaxHeader0000000000000000000000000000003200000000000010210 xustar0026 mtime=1713965750.57393 lesana-0.10.1/0000755000177700017770000000000014612205267013255 5ustar00valhallavalhalla././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1713965669.0 lesana-0.10.1/CHANGELOG.rst0000644000177700017770000000644514612205145015302 0ustar00valhallavalhalla*********** CHANGELOG *********** Unreleased ========== 0.10.1 ====== * Fix script installation via pyproject.toml. 0.10.0 ====== * Command line code has been split in the hazwaz library. * Code cleanup. * Modernize packaging with pyproject.toml and setuptool_scm. * Bump minimum supported Python version to 3.8. 0.9.1 ===== Bugfix release * Included the post-checkout script in the released package. 0.9.0 ===== * New data type: geo (for Geo URIs). * New custom filter for templates: to_yaml. * git hook to update the lesana cache when files are changed by git. This hook is installed when running ``lesana init``; you may want to add it to existing repositories by running ``lesana init`` on them (this is safe to do and won't change your settings or your data). * New command: get-values to get a list of values for a field. #6 * lesana-search now defaults to a query of ``'*'``. This means that ``lesana search --all`` is now enough to list all entries, while ``lesana search`` with no other options will list the first 12 entries (possibly according to a default sorting setting). * New collection example: ticket_tracker. * Add support for bash autocompletion via argcomplete, if installed. * Add support for the ``values`` property in the settings, to limit the contents of a field. * New property ``precision`` for ``decimal`` fields, to force rounding values to that number of decimal digits. * New settings property ``search_aliases`` with a dict of values to be filled in in a jinja2 template for a search query. * New experimental script openlibrary2lesana to search for book data on openlibrary and pre-fill a lesana entry. Bugfixes -------- * date fields are now parsed and loaded as date, not datetime. * help strings are added as comments with just one #, not two. 0.8.1 ===== Bugfix release. * Fixes running on an environment where EDITOR is not set. #7 * Fixes editing an entry. #8 * Fixes searches when default_sort isn't present. #9 0.8.0 ===== * New collection example: books. * Fixes to the tellico2lesana script (python 2.9 compatibility). * New option default_sort for collection, to sort search results by default. (#2) * Added support to sort the list of all entries. * Add the option to autofill date and datetime fields at creation and update time. (#1) * Add the option to autoincrement integer values. 0.7.0 ===== * Improved round trip loading of data results in less spurious changes when editing entries. * More documentation and examples. * Added support for sorting search results. * Added --reset option to lesana index. 0.6.2 ===== * Documentation improvements. * The timestamp field is now always interpreted as UTC. * Updated links to the published homepage and docs. 0.6.1 ===== * Tarball fixes 0.6.0 ===== * Validation of field contents have been made stricter: invalid contents that were accepted in the past may now cause an indexing error. * The timestamp field type is now deprecated and expected to contain a unix timestamp (a yaml datetime is accepted, but may be converted to a unix timestamp) and the types datetime and date have been added. 0.5.1 ===== Library ------- * This version changes the name of entry IDs from the nonsensical ``uid`` to ``eid`` (Entry ID) everywhere in the code, including the property ``Entry.uid`` and all method names. ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1713965055.0 lesana-0.10.1/MANIFEST.in0000644000177700017770000000035614612203777015023 0ustar00valhallavalhallaexclude .gitignore recursive-exclude .builds * recursive-include docs * recursive-exclude docs/build * include CHANGELOG.rst recursive-include tests/data * recursive-include scripts * include run_tests include run_coverage include run_qa ././@PaxHeader0000000000000000000000000000003200000000000010210 xustar0026 mtime=1713965750.57393 lesana-0.10.1/PKG-INFO0000644000177700017770000001126414612205267014356 0ustar00valhallavalhallaMetadata-Version: 2.1 Name: lesana Version: 0.10.1 Summary: Manage collection inventories throught yaml files. Author-email: Elena ``of Valhalla'' Grandi License: AGPLv3+ Project-URL: Homepage, https://lesana.trueelena.org/ Project-URL: Documentation, https://lesana.trueelena.org/ Project-URL: Repository, https://git.sr.ht/~valhalla/lesana Project-URL: Source, https://git.sr.ht/~valhalla/lesana Project-URL: Issues, https://todo.sr.ht/~valhalla/lesana Project-URL: Tracker, https://todo.sr.ht/~valhalla/lesana Project-URL: Changelog, https://git.sr.ht/~valhalla/lesana/tree/master/item/CHANGELOG.rst Project-URL: Mailing lists, https://sr.ht/~valhalla/lesana/lists Keywords: collection,inventory Classifier: Development Status :: 3 - Alpha Classifier: Environment :: Console Classifier: Intended Audience :: Developers Classifier: Intended Audience :: End Users/Desktop Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+) Classifier: Operating System :: POSIX Classifier: Programming Language :: Python :: 3 Classifier: Programming Language :: Python :: 3.8 Classifier: Programming Language :: Python :: 3.9 Classifier: Programming Language :: Python :: 3.10 Classifier: Programming Language :: Python :: 3.11 Classifier: Programming Language :: Python :: 3.12 Classifier: Topic :: Software Development :: Libraries :: Python Modules Classifier: Topic :: Utilities Requires-Python: >=3.8 Description-Content-Type: text/x-rst Requires-Dist: ruamel.yaml Requires-Dist: jinja2 Requires-Dist: python-dateutil Provides-Extra: cli Requires-Dist: hazwaz; extra == "cli" =============================== 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 `_. 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 . ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1704216686.0 lesana-0.10.1/README.rst0000644000177700017770000000612114545044156014747 0ustar00valhallavalhalla=============================== 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 `_. 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 . ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1622973869.0 lesana-0.10.1/TODO.rst0000644000177700017770000000041114057116655014555 0ustar00valhallavalhallaThe following features are already planned. The following features may be nice to have. * Having an indexing mode that adds the field as a value instead of a term, see https://getting-started-with-xapian.readthedocs.io/en/latest/concepts/indexing/values.html ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1657997594.0 lesana-0.10.1/agpl.txt0000644000177700017770000010333314264604432014744 0ustar00valhallavalhalla GNU AFFERO GENERAL PUBLIC LICENSE Version 3, 19 November 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU Affero General Public License is a free, copyleft license for software and other kinds of works, specifically designed to ensure cooperation with the community in the case of network server software. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, our General Public Licenses are intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. Developers that use our General Public Licenses protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License which gives you legal permission to copy, distribute and/or modify the software. A secondary benefit of defending all users' freedom is that improvements made in alternate versions of the program, if they receive widespread use, become available for other developers to incorporate. Many developers of free software are heartened and encouraged by the resulting cooperation. However, in the case of software used on network servers, this result may fail to come about. The GNU General Public License permits making a modified version and letting the public access it on a server without ever releasing its source code to the public. The GNU Affero General Public License is designed specifically to ensure that, in such cases, the modified source code becomes available to the community. It requires the operator of a network server to provide the source code of the modified version running there to the users of that server. Therefore, public use of a modified version, on a publicly accessible server, gives the public access to the source code of the modified version. An older license, called the Affero General Public License and published by Affero, was designed to accomplish similar goals. This is a different license, not a version of the Affero GPL, but Affero has released a new version of the Affero GPL which permits relicensing under this license. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. "This License" refers to version 3 of the GNU Affero General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Remote Network Interaction; Use with the GNU General Public License. Notwithstanding any other provision of this License, if you modify the Program, your modified version must prominently offer all users interacting with it remotely through a computer network (if your version supports such interaction) an opportunity to receive the Corresponding Source of your version by providing access to the Corresponding Source from a network server at no charge, through some standard or customary means of facilitating copying of software. This Corresponding Source shall include the Corresponding Source for any work covered by version 3 of the GNU General Public License that is incorporated pursuant to the following paragraph. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the work with which it is combined will remain governed by version 3 of the GNU General Public License. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU Affero General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU Affero General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU Affero General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU Affero General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) 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 Affero 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 . Also add information on how to contact you by electronic and paper mail. If your software can interact with users remotely through a computer network, you should also make sure that it provides a way for users to get its source. For example, if your program is a web application, its interface could display a "Source" link that leads users to an archive of the code. There are many ways you could offer source, and different solutions will be better for different programs; see section 13 for the specific requirements. You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU AGPL, see . ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1708888363.0 lesana-0.10.1/check0000755000177700017770000000144414566710453014271 0ustar00valhallavalhalla#!/bin/sh set -e if [ $# -lt 1 ] then $0 coverage $0 typecheck $0 qa exit 0 fi PYTHON="${PYTHON:-python3}" COVERAGE="${COVERAGE:-python3-coverage}" export PYTHONDEVMODE=1 SUBCMD=$1 shift 1 case $SUBCMD in "tests") $PYTHON -m unittest discover -s tests ;; "coverage") $COVERAGE run --source=lesana -m unittest discover -s tests $COVERAGE report -m ;; "qa") flake8 --select=E,F,W,C90,E123 --ignore=W503 lesana tests scripts isort --check-only --diff . if which doc8 then doc8 . fi ;; "typecheck") mypy lesana ;; "static") bandit --recursive --number=3 -lll -iii . ;; *) echo "No such subcommand $SUBCMD" ;; esac ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1713965750.5619297 lesana-0.10.1/docs/0000755000177700017770000000000014612205267014205 5ustar00valhallavalhalla././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1622973869.0 lesana-0.10.1/docs/.gitignore0000644000177700017770000000000614057116655016176 0ustar00valhallavalhallabuild ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1622973869.0 lesana-0.10.1/docs/Makefile0000644000177700017770000000117614057116655015657 0ustar00valhallavalhalla# Minimal makefile for Sphinx documentation # # You can set these variables from the command line, and also # from the environment for the first two. SPHINXOPTS ?= SPHINXBUILD ?= sphinx-build SOURCEDIR = source BUILDDIR = build # Put it first so that "make" without argument is like "make help". help: @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) .PHONY: help Makefile # Catch-all target: route all unknown targets to Sphinx using the new # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). %: Makefile @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1713965750.5619297 lesana-0.10.1/docs/examples/0000755000177700017770000000000014612205267016023 5ustar00valhallavalhalla././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1713965750.5619297 lesana-0.10.1/docs/examples/bookmarks/0000755000177700017770000000000014612205267020013 5ustar00valhallavalhalla././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1622973869.0 lesana-0.10.1/docs/examples/bookmarks/README.rst0000644000177700017770000000035314057116655021510 0ustar00valhallavalhalla############## My Bookmarks ############## This is an example collection of bookmarks. A page with all the bookmarks can be generated with the command:: lesana search --all --template templates/page.html '*' > my_bookmarks.html ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1622973869.0 lesana-0.10.1/docs/examples/bookmarks/settings.yaml0000644000177700017770000000061314057116655022544 0ustar00valhallavalhallaname: My Bookmarks lang: english entry_label: '{{ short_id }}: {{ title }} {{ url }}' git: true fields: - name: title type: string prefix: S index: free - name: url type: url index: field - name: description type: text index: free - name: tags type: list list: string index: field - name: added type: datetime index: field - name: updated type: datetime index: field ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1713965750.5619297 lesana-0.10.1/docs/examples/bookmarks/templates/0000755000177700017770000000000014612205267022011 5ustar00valhallavalhalla././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1622973869.0 lesana-0.10.1/docs/examples/bookmarks/templates/page.html0000644000177700017770000000062514057116655023623 0ustar00valhallavalhalla My Bookmarks

My Bookmarks

{% for entry in entries %}
{{ entry.data.title }}
{{ entry.data.description }}
{{ entry.data.added }}
    {% for t in entry.data.tags %}
  • {{ t }} {% endfor %}
{% endfor %}
././@PaxHeader0000000000000000000000000000003200000000000010210 xustar0026 mtime=1713965750.56593 lesana-0.10.1/docs/examples/books/0000755000177700017770000000000014612205267017140 5ustar00valhallavalhalla././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1622973869.0 lesana-0.10.1/docs/examples/books/README.txt0000644000177700017770000000031214057116655020637 0ustar00valhallavalhallaThis is an example lesana collection for books. The file ``import/from_tellico.yaml`` can be used with ``lesana export`` from a book collection generated by ``tellico2lesana`` from a tellico 3.x file. ././@PaxHeader0000000000000000000000000000003200000000000010210 xustar0026 mtime=1713965750.56593 lesana-0.10.1/docs/examples/books/import/0000755000177700017770000000000014612205267020452 5ustar00valhallavalhalla././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1622973869.0 lesana-0.10.1/docs/examples/books/import/from_tellico.yaml0000644000177700017770000000303614057116655024023 0ustar00valhallavalhallaasd: '{{ comments }}' title: '{{ title if title }}' subtitle: '{ subtitle if subtitle }}' authors: {% if authors %}{% for a in authors %} - "{{ a }}"{% endfor %}{% else %}[]{% endif %} editors: {% if editors %}{% for e in editors %} - "{{ e }}"{% endfor %}{% else %}[]{% endif %} binding: '{{ binding if binding}}' purchase_date: '{{ pur_date if pur_date }}' purchase_price: '{{ pur_price if pur_price }}' publisher: '{{ publisher if publisher }}' edition: '{{ edition if edition }}' copyright_year: {% if cr_years %}{% for y in cr_years %} - "{{ y }}"{% endfor %}{% else %}[]{% endif %} publication_year: {{ pub_year if pub_year }} isbn: '{{ isbn if isbn }}' lccn: '{{ iccn if iccn }}' pages: {{ pages if pages}} translators: {% if translators %}{% for t in translators %} - "{{ t }}"{% endfor %}{% else %}[]{% endif %} languages: {% if languages %}{% for l in languages %} - "{{ l }}"{% endfor %}{% else %}[]{% endif %} genres: {% if genres %}{% for g in genres %} - "{{ g }}"{% endfor %}{% else %}[]{% endif %} keywords: {% if keywords %}{% for k in keywords %} - "{{ k }}"{% endfor %}{% else %}[]{% endif %} series: '{{ series if series}}' series_number: {{ series_num if series_num }} condition: '{{ condition if condition}}' signed: {{ signed if signed}} read: {{ read if read }} gift: {{ gift if gift }} loaned: {{ loaned if loaned }} rating: {{ rating if rating }} cover: {{ cover if cover }} plot: | {{ plot if plot else '.' | indent(width=2, first=False) }} comments: | {{ comments if comments else '.' | indent(width=2, first=False) }} ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1622973869.0 lesana-0.10.1/docs/examples/books/settings.yaml0000644000177700017770000000270414057116655021674 0ustar00valhallavalhallaname: My Books lang: english entry_label: '{{ short_id }}: {{ authors | join("; ") }} - {{ title }}' git: false fields: - name: title type: string index: free - name: subtitle type: string index: free - name: authors type: list list: string index: free - name: editors type: list list: string index: free - name: binding type: string - name: purchase_date type: string index: field - name: purchase_price type: string index: field - name: publisher type: string index: field - name: edition type: string - name: copyright_year type: list list: integer index: field - name: publication_year type: integer index: field - name: isbn type: string index: field - name: lccn type: string index: field - name: pages type: integer - name: translators type: list list: string - name: languages type: list list: string index: field - name: genres type: list list: string index: field - name: keywords type: list list: string index: field - name: series type: string index: field - name: series_number type: integer - name: condition type: string index: field - name: signed type: boolean index: field - name: read type: boolean index: field - name: gift type: boolean index: field - name: loaned type: boolean index: field - name: rating type: integer index: field - name: cover type: file - name: plot type: text index: field - name: comments type: text index: field ././@PaxHeader0000000000000000000000000000003200000000000010210 xustar0026 mtime=1713965750.56593 lesana-0.10.1/docs/examples/books/templates/0000755000177700017770000000000014612205267021136 5ustar00valhallavalhalla././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1704214549.0 lesana-0.10.1/docs/examples/books/templates/from_openlibrary.yaml0000644000177700017770000000144114545040025025365 0ustar00valhallavalhallatitle: '{{ edition.title }}' subtitle: '' authors: {% if authors %}{% for a in authors %} - {{ a.name }}{% endfor %}{% else %}[]{% endif %} editors: [] binding: '' purchase_date: '' purchase_price: '' publisher: '{{ edition.publishers | join(", ") }}' edition: '' copyright_year: [] publication_year: {{ pub_date.year }} isbn: '{% if edition.isbn_13 %}{{ edition.isbn_13.0 }}{% else %}{% if edition.isbn_10 %}{{ edition.isbn_10.0 }}{% endif %}{% endif %}' lccn: '' openlibrary: 'https://openlibrary.org{{ edition.key }}' pages: {{ edition.number_of_pages }} translators: [] languages: {% if langs %}{% for l in langs %} - {{ l }}{% endfor %}{% else %}[]{% endif %} genres: [] keywords: [] series: '' series_number: 0 condition: '' signed: read: gift: loaned: rating: 0 cover: '' plot: '' comments: '' ././@PaxHeader0000000000000000000000000000003200000000000010210 xustar0026 mtime=1713965750.56593 lesana-0.10.1/docs/examples/music/0000755000177700017770000000000014612205267017143 5ustar00valhallavalhalla././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1622973869.0 lesana-0.10.1/docs/examples/music/README.txt0000644000177700017770000000030514057116655020644 0ustar00valhallavalhallaThis is an example lesana collection for music. The file ``import/from_tellico.yaml`` can be used with ``lesana export`` from a collection generated by ``tellico2lesana`` from a tellico 3.x file. ././@PaxHeader0000000000000000000000000000003200000000000010210 xustar0026 mtime=1713965750.56593 lesana-0.10.1/docs/examples/music/import/0000755000177700017770000000000014612205267020455 5ustar00valhallavalhalla././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1622973869.0 lesana-0.10.1/docs/examples/music/import/from_tellico.yaml0000644000177700017770000000141114057116655024021 0ustar00valhallavalhallatitle: "{{ title }}" artists: {% if artists %}{% for a in artists %} - "{{ a }}"{% endfor %}{% else %}[]{% endif %} label: {% if labels %}"{{ labels | join("; ") }}"{% else %}''{% endif %} year: '{{ year }}' genres: {% if genres %}{% for g in genres %} - "{{ g }}"{% endfor %}{% endif %} # medium (string): CD|DVD|Cassette|Vynil medium: '{{ medium }}' purchase_date: '{{ pur_date }}' purchase_price: '{{ pur_price }}' gift: "{{ gift }}" tracks: {% for t in tracks %} - title: "{{ t[0] }}" artist: "{{ t[1] | default('') | replace('None', '') }}" length: "{{ t[2] | default('') | replace('None', '') }}" side: "{{ t[3] | default('') | replace('None', '') }}"{% else %}[]{% endfor %} comments: | {{ comments | default('.') | indent(width=4, first=False) }} ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1622973869.0 lesana-0.10.1/docs/examples/music/settings.yaml0000644000177700017770000000117514057116655021700 0ustar00valhallavalhallaname: My Music lang: english entry_label: '{{ short_id }}: {{ artists | join("; ") }} / {{ title }}' git: true fields: - name: title type: string index: free - name: artists type: list list: string index: free - name: label type: string index: field - name: year type: integer index: field - name: genres type: list list: string index: field - name: medium type: string help: 'CD|DVD|Cassette|Vinyl|File' index: field - name: purchase_date type: string - name: purchase_price type: string - name: gift type: boolean - name: tracks type: list list: yaml - name: comments type: text index: free ././@PaxHeader0000000000000000000000000000003200000000000010210 xustar0026 mtime=1713965750.56593 lesana-0.10.1/docs/examples/ticket_tracker/0000755000177700017770000000000014612205267021021 5ustar00valhallavalhalla././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1631823357.0 lesana-0.10.1/docs/examples/ticket_tracker/README.rst0000644000177700017770000000034214120722775022511 0ustar00valhallavalhalla########### Our Tasks ########### This is an example on how to use lesana to manage a personal / few users ticket tracker. The file ``aliases.sh`` can be sourced (``. ./aliases.sh``) to provide helpers for common searches. ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1631980831.0 lesana-0.10.1/docs/examples/ticket_tracker/aliases.sh0000755000177700017770000000055614121406437023004 0ustar00valhallavalhalla#!/bin/sh LTT_STS_OPEN='\(status:planned OR status:ready OR status:"in progress" OR status:comments\)' LTT_STS_ACTIVE='\(status:"in progress" OR status:comments\)' LTT_STS_CLOSED='\(status:done OR status:invalid\)' alias ltt-s-open="lesana search $LTT_STS_OPEN" alias ltt-s-active="lesana search $LTT_STS_ACTIVE" alias ltt-s-closed="lesana search $LTT_STS_CLOSED" ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1640337836.0 lesana-0.10.1/docs/examples/ticket_tracker/settings.yaml0000644000177700017770000000131614161310654023542 0ustar00valhallavalhallaname: Our tasks lang: english entry_label: '{{ short_id }}: {{ name }} [{{ status }}]' git: true search_aliases: open: '(status:planned OR status:ready OR status:"in progress" OR status:comments)' active: '(status:"in progress" OR status:comments)' closed: '(status:done OR status:invalid)' fields: - name: name type: string prefix: S index: free - name: description type: text index: free - name: status type: text index: field sortable: true values: - planned - ready - in progress - comments - done - invalid - name: assignee type: string index: field help: insert your list of potential assignees here - name: comments type: list list: text index: free ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1657997594.0 lesana-0.10.1/docs/field_types.rst0000644000177700017770000000044414264604432017250 0ustar00valhallavalhalla------------- Field Types ------------- string: a string of unicode text. text: a longer block of unicode text; integer: . float: . decimal: . timestamp: . datetime: . date: . boolean: . file: . url: . geo: A Geo URI. list: . yaml: . ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1622973869.0 lesana-0.10.1/docs/make.bat0000644000177700017770000000143714057116655015624 0ustar00valhallavalhalla@ECHO OFF pushd %~dp0 REM Command file for Sphinx documentation if "%SPHINXBUILD%" == "" ( set SPHINXBUILD=sphinx-build ) set SOURCEDIR=source set BUILDDIR=build if "%1" == "" goto help %SPHINXBUILD% >NUL 2>NUL if errorlevel 9009 ( echo. echo.The 'sphinx-build' command was not found. Make sure you have Sphinx echo.installed, then set the SPHINXBUILD environment variable to point echo.to the full path of the 'sphinx-build' executable. Alternatively you echo.may add the Sphinx directory to PATH. echo. echo.If you don't have Sphinx installed, grab it from echo.http://sphinx-doc.org/ exit /b 1 ) %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% goto end :help %SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% :end popd ././@PaxHeader0000000000000000000000000000003200000000000010210 xustar0026 mtime=1713965750.56593 lesana-0.10.1/docs/source/0000755000177700017770000000000014612205267015505 5ustar00valhallavalhalla././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1640963091.0 lesana-0.10.1/docs/source/conf.py0000644000177700017770000000632114163616023017003 0ustar00valhallavalhalla# Configuration file for the Sphinx documentation builder. # # This file only contains a selection of the most common options. For a full # list see the documentation: # https://www.sphinx-doc.org/en/master/usage/configuration.html # -- Path setup -------------------------------------------------------------- # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. # # import os # import sys # sys.path.insert(0, os.path.abspath('.')) # -- Project information ----------------------------------------------------- project = 'lesana' copyright = "2020-2021, Elena Grandi" author = "Elena ``of Valhalla''" # The full version, including alpha/beta/rc tags release = '0.10.0dev' # The major project version version = '0.10' # compatibility with sphinx 1.8 on buster master_doc = 'index' # -- General configuration --------------------------------------------------- # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.viewcode', ] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This pattern also affects html_static_path and html_extra_path. exclude_patterns = [] # -- Options for HTML output ------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # html_theme = 'alabaster' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] man_pages = [ ( 'man/lesana', 'lesana', 'manages collection inventories', 'valhalla@trueelena.org', 1 ), ( 'man/lesana-edit', 'lesana-edit', 'edits an existing lesana entry', 'valhalla@trueelena.org', 1 ), ( 'man/lesana-export', 'lesana-export', 'export data from one lesana collection to another', 'valhalla@trueelena.org', 1 ), ( 'man/lesana-index', 'lesana-index', 'Index some entries', 'valhalla@trueelena.org', 1 ), ( 'man/lesana-init', 'lesana-init', 'initialize a lesana collection', 'valhalla@trueelena.org', 1 ), ( 'man/lesana-new', 'lesana-new', 'create a new lesana entry', 'valhalla@trueelena.org', 1 ), ( 'man/lesana-rm', 'lesana-rm', 'remove an entry from a lesana collection', 'valhalla@trueelena.org', 1 ), ( 'man/lesana-search', 'lesana-search', 'search inside a lesana collection', 'valhalla@trueelena.org', 1 ), ( 'man/lesana-show', 'lesana-show', 'show a lesana entry', 'valhalla@trueelena.org', 1 ), ] ././@PaxHeader0000000000000000000000000000003200000000000010210 xustar0026 mtime=1713965750.56593 lesana-0.10.1/docs/source/contrib/0000755000177700017770000000000014612205267017145 5ustar00valhallavalhalla././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1622973869.0 lesana-0.10.1/docs/source/contrib/index.rst0000644000177700017770000000033014057116655021007 0ustar00valhallavalhalla########################### Contributor Documentation ########################### Documentation that is useful for contributors of lesana. .. toctree:: :maxdepth: 2 :caption: Contents: release_procedure ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1713250472.0 lesana-0.10.1/docs/source/contrib/release_procedure.rst0000644000177700017770000000132614607420250023364 0ustar00valhallavalhalla******************* Release procedure ******************* * Check that the version number in setup.py and in docs/source/conf.py is correct. * Check that the changelog is up to date. * Tag the version you are preparing:: $ git tag -s v$VERSION $ git push $ git push --tags for the tag content use something like:: Version $VERSION * contents * of the relevant * changelog * Generate the distribution files:: $ python3 -m build * Upload :: $ twine upload -s dist/* * Send the release announce to:: valhalla/lesana-announce@lists.sr.ht, ~valhalla/lesana-discuss@lists.sr.ht * Close the bugs marked as pending_release on https://todo.sr.ht/~valhalla/lesana. ././@PaxHeader0000000000000000000000000000003200000000000010210 xustar0026 mtime=1713965750.56593 lesana-0.10.1/docs/source/devel/0000755000177700017770000000000014612205267016604 5ustar00valhallavalhalla././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1622973869.0 lesana-0.10.1/docs/source/devel/index.rst0000644000177700017770000000034014057116655020447 0ustar00valhallavalhalla######################### Developer Documentation ######################### Documentation that is useful for developers who are using lesana as a library. .. toctree:: :maxdepth: 2 :caption: Contents: promises ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1622973869.0 lesana-0.10.1/docs/source/devel/promises.rst0000644000177700017770000000175214057116655021211 0ustar00valhallavalhalla******** Promises ******** Semantic versioning =================== This project uses semver_. .. _semver: http://semver.org/ Collection format stability =========================== Future versions of lesana will be able to read collections written by older versions. Older versions in the same mayor release will also be able to work concurrently on the same repository. If in the future a change of formats will be required, conversions scripts will be written in a way that will make them as stable as possibile, and will have enought test data to keep them maintained for the time being. Disposable cache ================ Contrary to the yaml files, the xapian cache is considered disposable: from time to time there may be a need to delete the cache and reindex everything, either because of an upgrade or to perform repository mainteinance. Of course, effort will be made to reduce the need for this so that it only happens sporadically, but it will probably never completely disappear. ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1640348093.0 lesana-0.10.1/docs/source/index.rst0000644000177700017770000000244714161334675017362 0ustar00valhallavalhalla.. lesana documentation master file, created by sphinx-quickstart on Thu Oct 1 22:28:26 2020. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. .. include:: ../../README.rst 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 [#onion]_. .. [#onion] Everything is also available via onion, at http://aublvconhsld6cvcf3dbibffzih2un5bicp3s3b5qmkskof26p3pssqd.onion/ The author can be contacted via email: webmaster AT trueelena DOT org. .. only:: html Status Badges ------------- Packaging ^^^^^^^^^ .. image:: https://repology.org/badge/vertical-allrepos/lesana.svg :target: https://repology.org/project/lesana/versions CI ^^ .. image:: https://builds.sr.ht/~valhalla/lesana.svg :target: https://builds.sr.ht/~valhalla/lesana Contents -------- .. toctree:: :maxdepth: 2 :caption: Contents: user/index devel/index contrib/index man/index reference/modules Indices and tables ------------------ * :ref:`genindex` * :ref:`modindex` * :ref:`search` ././@PaxHeader0000000000000000000000000000003200000000000010210 xustar0026 mtime=1713965750.56593 lesana-0.10.1/docs/source/man/0000755000177700017770000000000014612205267016260 5ustar00valhallavalhalla././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1622973869.0 lesana-0.10.1/docs/source/man/Makefile0000644000177700017770000000021414057116655017722 0ustar00valhallavalhalla MAN_TARGETS = $(patsubst %.rst,%.1,$(wildcard *.rst)) all: $(MAN_TARGETS) %.1: %.rst rst2man $< > $@ clean: rm *.1 .PHONY: all clean ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1622973869.0 lesana-0.10.1/docs/source/man/index.rst0000644000177700017770000000035514057116655020131 0ustar00valhallavalhalla********* Man Pages ********* .. toctree:: :maxdepth: 2 :caption: Contents: lesana-edit lesana-export lesana-index lesana-init lesana-new lesana-rm lesana lesana-search lesana-get-values lesana-show ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1622973869.0 lesana-0.10.1/docs/source/man/lesana-edit.rst0000644000177700017770000000114614057116655021207 0ustar00valhallavalhalla=========== lesana-edit =========== SYNOPSIS ======== lesana edit [--help] [--collection ] [--no-git] DESCRIPTION =========== Lesana edit will open an existing entry (specified by id or partial id) in an editor, so that it can be changed. If the collection is configured to use git, after the editor has been closed, it will add the file to the git staging area, unless ``--no-git`` is given. OPTIONS ======= -h, --help Prints an help message and exits. --collection COLLECTION, -c COLLECTION The collection to work on. Default is ``.`` --no-git Don't add the new entry to git. ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1657997594.0 lesana-0.10.1/docs/source/man/lesana-export.rst0000644000177700017770000000075214264604432021600 0ustar00valhallavalhalla============= lesana-export ============= SYNOPSIS ======== lesana export [-h] [--collection COLLECTION] [--query QUERY] \ destination template DESCRIPTION =========== Lesana export converts entries from one lesana collection to another, using a jinja2 template. OPTIONS ======= -h, --help Prints an help message and exits. --collection COLLECTION, -c COLLECTION The collection to work on. Default is ``.`` --query QUERY, -q QUERY Xapian query to search in the collection ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1622973869.0 lesana-0.10.1/docs/source/man/lesana-get-values.rst0000644000177700017770000000151414057116655022335 0ustar00valhallavalhalla================= lesana-get-values ================= SYNOPSIS ======== lesana search [--help] [--collection COLLECTION] [--template TEMPLATE] \ --field FIELD [query [query ...]] DESCRIPTION =========== Lesana get-values will list all values found in a field and the number of entries where that value has been found. A template can be specified to format the results. Extracting the values from a sortable field is significantly more efficient than doing so from a non-sortable field, but adding too many sortable fields can make general searches and indexing slower. OPTIONS ======= -h, --help Prints an help message and exits. --collection COLLECTION, -c COLLECTION The collection to work on. Default is ``.`` --template TEMPLATE, -t TEMPLATE Template to use when displaying results --field Name of the desired field. ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1622973869.0 lesana-0.10.1/docs/source/man/lesana-index.rst0000644000177700017770000000076214057116655021374 0ustar00valhallavalhalla============ lesana-index ============ SYNOPSIS ======== lesana index [--help] [--collection COLLECTION] [files [files ...]] DESCRIPTION =========== Lesana index adds some entries to the xapian cache, listed by filename (by default all of the files found in the items directory). OPTIONS ======= -h, --help Prints an help message and exits. --collection COLLECTION, -c COLLECTION The collection to work on. Default is ``.`` --reset Delete the existing xapian cache before indexing. ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1622973869.0 lesana-0.10.1/docs/source/man/lesana-init.rst0000644000177700017770000000214114057116655021221 0ustar00valhallavalhalla=========== lesana-init =========== SYNOPSIS ======== lesana init [--help] [--collection ] [--no-git] DESCRIPTION =========== lesana init initializes a new lesana collection. It will create the directory (if it does not exist) and, unless ``--no-git`` is specified it will initialize it as a git repository, create a ``.gitignore`` file with some relevant contents and add hooks to update the local cache when the files are changed via git. It will then create a skeleton ``settings.yaml`` file and open it in an editor to start configuring the collection. When leaving the editor, again unless ``--no-git`` is used, it will add this file to the git staging area, but not commit it. It is safe to run this command on an existing repository, e.g. to install the hooks on a new clone, but it will overwrite the hooks themselves even if they have been changed by the user. OPTIONS ======= --help, -h Prints an help message and exits. --collection COLLECTION, -c COLLECTION The directory where the collection will be initialized. Default is . --no-git Do not use git in the current collection. ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1622973869.0 lesana-0.10.1/docs/source/man/lesana-new.rst0000644000177700017770000000113414057116655021050 0ustar00valhallavalhalla========== lesana-new ========== SYNOPSIS ======== lesana new [--help] [--collection ] [--no-git] DESCRIPTION =========== Lesana new creates a new lesana entry. It will create an empty entry and open an editor so that it can be filled. If the collection is configured to use git, after the editor has been closed, it will add the file to the git staging area, unless ``--no-git`` is given. OPTIONS ======= -h, --help Prints an help message and exits. --collection COLLECTION, -c COLLECTION The collection to work on. Default is ``.`` --no-git Don't add the new entry to git. ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1622973869.0 lesana-0.10.1/docs/source/man/lesana-rm.rst0000644000177700017770000000060114057116655020673 0ustar00valhallavalhalla========= lesana-rm ========= SYNOPSIS ======== lesana rm [-h] [--collection COLLECTION] entries [entries ...] DESCRIPTION =========== Lesana rm removes an entry from the collection, removing both the file and the cached entry. OPTIONS ======= -h, --help Prints an help message and exits. --collection COLLECTION, -c COLLECTION The collection to work on. Default is ``.`` ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1657997594.0 lesana-0.10.1/docs/source/man/lesana-search.rst0000644000177700017770000000321514264604432021521 0ustar00valhallavalhalla============= lesana-search ============= SYNOPSIS ======== lesana search [--help] [--collection COLLECTION] [--template TEMPLATE] \ [--offset OFFSET] [--pagesize PAGESIZE] [--all] \ [--expand-query-template] [--sort FIELD1 [--sort FIELD2 ...]] \ [query [query ...]] DESCRIPTION =========== Lesana search allows one to make searches in the collection and render the results. The section :doc:`/user/search` in the full documentation describes the query syntax in more detail; it is available online at https://lesana.trueelena.org/user/search.html or it may be installed on your system (e.g. in Debian and derivatives it will be at ``/usr/share/doc/lesana/html/user/search.html``). By default entries are printed according to the ``entry_label`` from the ``settings.yaml`` file, but they can be rendered according to a jinja2 template. If no query is specified, it will default to ``'*'``, i.e. search all entries: thus ``lesana search --all`` will print all entries, while just ``lesana search`` will print the first 12 entries, possibly according to the relevant sorting options. OPTIONS ======= -h, --help Prints an help message and exits. --collection COLLECTION, -c COLLECTION The collection to work on. Default is ``.`` --template TEMPLATE, -t TEMPLATE Template to use when displaying results --offset OFFSET . --pagesize PAGESIZE . --all Return all available results --sort Sort the results by a sortable field. This option can be added multiple times; prefix the name of the field with ``-`` to reverse the results (e.g. ``--sort='-date'``). --expand-query-template Render search_aliases in the query as a jinja2 template ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1622973869.0 lesana-0.10.1/docs/source/man/lesana-show.rst0000644000177700017770000000154614057116655021246 0ustar00valhallavalhalla=========== lesana-show =========== SYNOPSIS ======== lesana show [--help] [--collection COLLECTION] [--template TEMPLATE] DESCRIPTION =========== ``lesana show`` will print an entry (specified by id or partial id) to stdout. A template can be specified with ``--template