]> git.phdru.name Git - m_librarian.git/blob - docs-ru/before_begin.rst
555db2b1729ec5198dbe4b63f3c5668096b5345e
[m_librarian.git] / docs-ru / before_begin.rst
1
2 Прежде чем вы начнёте
3 =====================
4
5 Прежде чем вы начнёте, вам потребуются некоторые приготовления.
6
7
8 .. contents::
9    :local:
10
11 .. highlight:: none
12
13 Программное обеспечение
14 -----------------------
15
16 m_Librarian написан на языке Python, так что вам нужно скачать и
17 установить Python (2.7 или 3.4+). Нужны также библиотеки SQLObject и
18 m_lib.defenc.
19
20
21 Архивы библиотек
22 ----------------
23
24 Данный программный комплекс работает с локальными файлами библиотек, так
25 что предварительно скачайте некоторые библиотеки. Вот краткий и совсем
26 не исчерпывающий список для скачивания:
27
28 | http://torrent.rus.ec/index.php?c=3
29 | http://booktracker.org/index.php?c=18
30 | https://nnm-club.me/forum/viewtopic.php?t=353958
31 | https://nnm-club.me/forum/viewtopic.php?t=510054
32 | https://nnm-club.me/forum/viewtopic.php?t=521962
33 | https://nnm-club.me/forum/viewtopic.php?t=877707
34
35 Кроме самих библиотек вам понадобиться найти для них индексы INPX —
36 m_Librarian пока не научился индексировать архивы библиотек.
37
38 Индексы INPX обычно распространяются вместе с программами для работы с
39 библиотеками, и такие программы есть в архивах по ссылкам выше.
40 Некоторые индексы можно скачать с сайта одной из таких программ
41 `MyHomeLib <http://home-lib.net/>`_:
42
43 | http://home-lib.net/download/inpx/librusec_local_fb2.inpx
44 | http://home-lib.net/download/inpx/librusec_local_usr.inpx
45 | http://home-lib.net/download/inpx/librusec_local_all.inpx
46
47
48 Файл конфигурации
49 -----------------
50
51 Файл конфигурации по умолчанию ищется в $HOME/.config/ (если у вас
52 POSIX-совместимая ОС). Файл должен называться ``m_librarian.conf``. Это
53 должен быть файл в формате ``ini``. В настоящий момент m_librarian
54 понимает следующие секции и ключи в них::
55
56     [database]
57     URI = "DB URI"
58
59     [library]
60     path = "путь к архивам библиотеки"
61
62     [download]
63     format = "формат имён сохраняемых файлов"
64
65 Большинство программ имею опцию `-C|--config config`, которая позволяет
66 использовать файл произвольный конфигурации.
67
68 База данных
69 -----------
70
71 Для работы m_Librarian требуется база данных. m_Librarian может работать
72 с любой БД, поддерживаемой библиотекой SQLObject. Предпочтительные
73 варианты: MySQL, PostgreSQL или SQLite. При использовании сервера SQL БД
74 вам придётся создать самим. Для SQLite файл БД будет создан программой,
75 так что это наиболее простой способ использования m_Librarian,
76
77 Database URI
78 ^^^^^^^^^^^^
79
80 Чтобы m_Librarian использовал сервер SQL в файле конфигурации должна
81 быть секция ``[database]`` с единственным ключом ``URI``. Значением
82 ключа должно быть Database URI в формате, который понимает SQLObject.
83 Вот несколько примеров::
84
85    [database]
86    URI = mysql://user:password@host/database
87
88    [database]
89    URI = postgres://user@host/database
90
91    [database]
92    URI = sqlite:///full/path/to/database
93
94 Больше примеров есть в файле sample/m_librarian.conf. Детальное описание
95 DB URI есть в `документации на SQLObject
96 <http://sqlobject.org/SQLObject.html#declaring-a-connection>`_.
97
98 .. vim: set tw=72 :