From c658e0898734b1d3c73853f393cc4d57c92276be Mon Sep 17 00:00:00 2001 From: Elena ``of Valhalla'' Grandi Date: Sun, 11 Dec 2016 22:03:14 +0100 Subject: Initial bits of documentation --- README.rst | 21 +++++++++++++++++++++ docs/field_types.rst | 22 ++++++++++++++++++++++ 2 files changed, 43 insertions(+) create mode 100644 docs/field_types.rst diff --git a/README.rst b/README.rst index bcf68f3..648ed19 100644 --- a/README.rst +++ b/README.rst @@ -1,3 +1,24 @@ =============================== lesana - a collection manager =============================== + +lesana is a python3 library to organize collections of various kinds +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 +either by simply writing a personalize schema.yaml or, in more complex +cases, by inheriting from it in another module. diff --git a/docs/field_types.rst b/docs/field_types.rst new file mode 100644 index 0000000..9008348 --- /dev/null +++ b/docs/field_types.rst @@ -0,0 +1,22 @@ +------------- + Field Types +------------- + +string: + a string of unicode text. +text: + a longer block of unicode text; +integer: + . +float: + . +timestamp: + . +file: + . +url: + . +list: + . +yaml: + . -- cgit v1.2.3