summaryrefslogtreecommitdiffstats
path: root/README.rst
blob: b79a7c86f35bdc240e0a34e529d5040746434fe2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
KittyStore
==========

:Author: Pierre-Yves Chibon <pingou@pingoured.fr>
:Author: Aurélien Bompard <abompard@fedoraproject.org>


KittyStore is the archiving library for `HyperKitty`_, the Mailman 3 archiver. It provides an interface to different storage systems. Currenty only the `Storm ORM`_ system is supported.

.. _HyperKitty: https://fedorahosted.org/hyperkitty
.. _Storm ORM: http://storm.canonical.com


Get this project:
-----------------
Source:  https://github.com/pypingou/kittystore


Dependencies:
-------------
- SQLAlchemy


License:
--------

.. _GPL v2.0: http://www.gnu.org/licenses/gpl-2.0.html

``KittyStore`` is licensed under the `GPL v2.0`_

Load the database:
------------------

- Retrieve the archives using the get_mbox.py script
- Configure the to_sqldb.py script (adjust user/password/database name/host/port)
- Load the archives by calling the to_sqldb.py script
(this might be memory intensive, so you may want to do 2 or 3 years per run and split
the runs)

Alternatively, to load the data you may want to do something like:
  for i in lists/devel-*; do python to_sqldb.py devel $i; done;