5 Before you begin you need some preparations.
16 m_Librarian is written in Python and requires Python (2.7 or 3.4+). So
17 install Python first. Install required modules: SQLObject and
18 m_lib.defenc. pip `installs <install.html>`_ required modules
25 The program works with local library archives so download some. In
26 addition to the very libraries you need to get INPX indices for them —
27 m_Librarian cannot index libraries yet.
32 m_librarian looks up configuration file in $HOME/.config/ (if your OS is
33 POSIX-compatible). The configuration file must be named
34 ``m_librarian.conf``. It must be in ``ini``-file format. The following
35 sections and keys are now understood::
41 path = "path to the library archives"
44 format = "download file format"
46 Most programs have an option `-C|--config file` to use a non-default
52 The program needs a database. It can work with any database supported by
53 SQLObject. Preferred ones are: MySQL, PostgreSQL or SQLite. If you plan
54 to use an SQL server you must create a database yourself. For SQLite,
55 the database file will be created by the program, so it's the simplest
56 way of using m_Librarian.
61 In configuration file define section ``[database]`` with the only key
62 ``URI``. The value for the key must be a Database URI in format accepted
63 by SQLObject. Some examples::
66 URI = mysql://user:password@host/database
69 URI = postgres://user@host/database
72 URI = sqlite:///full/path/to/database
74 See some more examples in m_librarian.conf.sample. See detailed
75 description for DB URIs in `SQLObject documentation
76 <http://sqlobject.org/SQLObject.html#declaring-a-connection>`_.