summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAurélien Bompard <aurelien@bompard.org>2012-11-21 17:07:10 +0100
committerAurélien Bompard <aurelien@bompard.org>2012-11-21 17:07:10 +0100
commit9a75b2d6fb2c15477e27afc90fe588d3f12d2744 (patch)
tree38d9c1b1a2bf13297e4afe12e103a6e9bce2fae3
parentc83971a10ffb2168e57ebb7a5230970319417036 (diff)
downloadkittystore-9a75b2d6fb2c15477e27afc90fe588d3f12d2744.tar.gz
kittystore-9a75b2d6fb2c15477e27afc90fe588d3f12d2744.tar.xz
kittystore-9a75b2d6fb2c15477e27afc90fe588d3f12d2744.zip
Update metadata
-rw-r--r--AUTHORS.txt2
-rw-r--r--README.rst44
-rw-r--r--requirements.txt1
3 files changed, 21 insertions, 26 deletions
diff --git a/AUTHORS.txt b/AUTHORS.txt
index 483a96a..5abffe7 100644
--- a/AUTHORS.txt
+++ b/AUTHORS.txt
@@ -1,3 +1,3 @@
-Aamir Khan <syst3m.w0rm@gmail.com>
Pierre-Yves Chibon <pingou@pingoured.fr>
Aurelien Bompard <aurelien@bompard.org>
+Aamir Khan <syst3m.w0rm@gmail.com>
diff --git a/README.rst b/README.rst
index b79a7c8..f10e594 100644
--- a/README.rst
+++ b/README.rst
@@ -1,42 +1,38 @@
+==========
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.
+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
+The code is available from: https://github.com/pypingou/kittystore
+
-Get this project:
------------------
-Source: https://github.com/pypingou/kittystore
+Populating the database
+=======================
+- Retrieve the archives using the ``get_mbox.py`` script
+- Load the archives by calling ``kittystore-import``.
-Dependencies:
--------------
-- SQLAlchemy
+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::
-License:
---------
+ for i in lists/devel-*; do kittystore-import -l devel@fp.o $i; done;
-.. _GPL v2.0: http://www.gnu.org/licenses/gpl-2.0.html
-``KittyStore`` is licensed under the `GPL v2.0`_
+License
+=======
-Load the database:
-------------------
+The authors are listed in the ``AUTHORS.txt`` file.
-- 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)
+Copyright (C) 2012 by the Free Software Foundation, Inc.
-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;
+``KittyStore`` is licensed under the `GPL v3.0`_
+.. _GPL v3.0: http://www.gnu.org/licenses/gpl-3.0.html
diff --git a/requirements.txt b/requirements.txt
index 02fb624..70895f4 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -1,6 +1,5 @@
mailman
zope.interface
-SQLAlchemy==0.7.8
storm
python-dateutil < 2.0 # 2.0+ is for Python 3
mock