Prepare for release

7 files changed, 585 insertions, 0 deletions

diff --git a/doc/Makefile b/doc/Makefile
new file mode 100644
index 0000000..ef38d84
--- /dev/null
+++ b/doc/Makefile
@@ -0,0 +1,130 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	-rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/HyperKitty.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/HyperKitty.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/HyperKitty"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/HyperKitty"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	make -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
diff --git a/doc/conf.py b/doc/conf.py
new file mode 100644
index 0000000..fb0d4a8
--- /dev/null
+++ b/doc/conf.py
@@ -0,0 +1,216 @@
+# -*- coding: utf-8 -*-
+#
+# HyperKitty documentation build configuration file, created by
+# sphinx-quickstart on Fri Aug 10 19:46:05 2012.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = []
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'HyperKitty'
+copyright = u'2012, HyperKitty Developers'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '0.1'
+# The full version, including alpha/beta/rc tags.
+release = '0.1'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build', 'database.rst']
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'HyperKittydoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'HyperKitty.tex', u'HyperKitty Documentation',
+   u'Mailman Coders', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'hyperkitty', u'HyperKitty Documentation',
+     [u'Mailman Coders'], 1)
+]
diff --git a/doc/database.rst b/doc/database.rst
new file mode 100644
index 0000000..1eb8e9a
--- /dev/null
+++ b/doc/database.rst
@@ -0,0 +1,18 @@
+Setting up the databases
+========================
+
+Now you can create the KittyStore and HyperKitty databases, and set their
+access URLs in ``hyperkitty_standalone/settings.py`` (or
+``hyperkitty_standalone/settings_local.py``). HyperKitty's database can be
+created using the following command::
+
+    python manage.py syncdb
+
+KittyStore's database will be created automatically on first access.
+
+Then, you can run ``kittystore-import`` to import existing archives into the
+mailman database. Thoses archives can be downloaded by a script similar to the
+``get_mbox.py`` script provided in the ``kittystore`` module. If you're
+installing hyperkitty on the machine which hosted the previous version of
+mailman, the archived are already available locally and you can use them
+directly.
diff --git a/doc/development.rst b/doc/development.rst
new file mode 100644
index 0000000..da8ddcd
--- /dev/null
+++ b/doc/development.rst
@@ -0,0 +1,67 @@
+===========
+Development
+===========
+
+
+Communication channels
+======================
+
+Hang out on IRC and ask questions on ``#mailman`` or join the mailing list
+``hyperkitty-devel@lists.fedorahosted.org``.
+
+
+Setting up Hyperkitty for development
+=====================================
+
+The recommanded way to develop on HyperKitty is to use VirtualEnv. It will
+create an isolated Python environment where you can add HyperKitty and its
+dependencies without messing up your system Python install.
+
+First, create the virtualenv and activate it::
+
+    virtualenv venv_hk
+    source venv_hk/bin/activate
+
+Then download the components of HyperKitty::
+
+    git clone git://github.com/pypingou/kittystore.git
+    cd kittystore
+    python setup.py develop
+    cd ..
+    bzr branch bzr://bzr.fedorahosted.org/bzr/hyperkitty/hyperkitty
+    cd hyperkitty
+    python setup.py develop
+    cd ..
+    bzr branch bzr://bzr.fedorahosted.org/bzr/hyperkitty/hyperkitty_standalone
+
+
+.. Setting up the databases
+
+.. include:: database.rst
+
+
+Running HyperKitty
+==================
+
+If you're coding on HyperKitty, you can use Django's integrated web server.
+It can be run with the following command::
+
+    cd hyperkitty_standalone
+    python manage.py runserver
+
+.. warning::
+    You should use the development server only locally. While it's possible to
+    make your site publicly available using the dev server, you should never
+    do that in a production environment.
+
+
+Testing
+=======
+
+Use the following command::
+
+    python manage.py test hyperkitty
+
+All test modules reside in the ``hyperkitty/tests`` directory
+and this is where you should put your own tests, too. To make the django test
+runner find your tests, make sure to add them to the folder's ``__init__.py``:
diff --git a/doc/index.rst b/doc/index.rst
new file mode 100644
index 0000000..1936a49
--- /dev/null
+++ b/doc/index.rst
@@ -0,0 +1,35 @@
+======================================
+Welcome to HyperKitty's documentation!
+======================================
+
+The HyperKitty Django app provides a web interface to access GNU Mailman v3
+archives.
+
+The project page is https://fedorahosted.org/hyperkitty/ and the code is
+available from http://bzr.fedorahosted.org/bzr/hyperkitty/ .
+
+The authors are listed in the ``AUTHORS.txt`` file.
+
+Contents:
+
+.. toctree::
+   :maxdepth: 1
+   
+   news.rst
+   install.rst
+   development.rst
+
+Copyright (C) 2012 by the Free Software Foundation, Inc.
+
+HyperKitty is free software: you can redistribute it and/or
+modify it under the terms of the GNU General Public License as
+published by the Free Software Foundation, version 3 of the License.
+
+HyperKitty is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
+General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with HyperKitty. If not, see <http://www.gnu.org/licenses/>.
+
diff --git a/doc/install.rst b/doc/install.rst
new file mode 100644
index 0000000..6827054
--- /dev/null
+++ b/doc/install.rst
@@ -0,0 +1,104 @@
+============
+Installation
+============
+
+.. note::
+    This installation guide covers HyperKitty, the web user interface to access
+    GNU Mailman v3 Archives. To install GNU Mailman follow the instructions in
+    the documentation: http://packages.python.org/mailman/
+
+
+Install the code
+================
+
+Install the HyperKitty package and its dependencies with the following
+commands::
+
+    sudo pip install -r requirements.txt
+    sudo python setup.py install
+
+
+Setup your django project
+=========================
+
+You now have installed the necessary packages but you still need to setup the
+Django site (project).
+
+First, get the project directory from the source code management system::
+
+    bzr branch bzr://bzr.fedorahosted.org/bzr/hyperkitty/hyperkitty_standalone
+
+Second, change the database setting in ``hyperkitty_standalone/settings.py`` to
+your preferred database. HyperKitty uses two databases, one to store the metadata
+and other to store the emails. Edit this file to reflect the correct database
+credentials. The configuration variables are ``DATABASES`` (at the top of the
+file) and ``KITTYSTORE_URL`` (at the bottom).
+
+.. note::
+    Detailed information on how to use different database engines can be found
+    in the `Django documentation`_.
+
+.. _Django documentation: https://docs.djangoproject.com/en/1.4/ref/settings/#databases
+
+Third, you must setup the database tables, and the admin account (you will be
+prompted for it).
+
+
+.. Setting up the databases
+
+.. include:: database.rst
+
+
+Running HyperKitty on Apache with mod_wsgi
+==========================================
+
+.. note::
+    This guide assumes that you know how to setup a VirtualHost with Apache.
+    If you are using SQLite, the ``.db`` file as well as its folder need to be
+    writable by the web server.
+
+Edit ``hyperkitty_standalone/hyperkitty.apache.conf`` to point to your source
+code location.
+
+Add following line to your apache/httpd configuration file::
+
+    Include "/{path-to-hyperkitty_standalone}/hyperkitty.apache.conf"
+
+And reload Apache. We're almost ready. But you need to collect the static files
+from HyperKitty (which resides somewhere on your pythonpath) to be able to
+serve them from the site directory. All you have to do is to change into the
+``hyperkitty_standalone`` directory and run::
+
+    python manage.py collectstatic
+
+These static files will be served by Apache. You should now be all set. Try
+accessing HyperKitty in your web browser.
+
+
+Connecting to Mailman
+=====================
+
+To receive incoming emails from Mailman, you must add the follwing lines to
+``mailman.cfg``::
+
+    [archiver.hyperkitty]
+    class: hyperkitty.lib.archiver.Archiver
+    enable: yes
+    configuration: /path/to/hyperkitty_standalone/hyperkitty.cfg
+
+The ``hyperkitty.cfg`` file which path is specified by the ``configuration``
+key is an additional HyperKitty-specific configuration file for which an
+example is provided. See the included ``hyperkitty_standalone/hyperkitty.cfg``
+file.
+
+After having made these changes, you must restart Mailman. Check its log files
+to make sure the emails are correctly archived. You should not see "``Broken
+archiver: hyperkitty``" messages.
+
+
+License
+=======
+
+HyperKitty is licensed under the `GPL v3.0`_
+
+.. _GPL v3.0: http://www.gnu.org/licenses/gpl-3.0.html
diff --git a/doc/news.rst b/doc/news.rst
new file mode 100644
index 0000000..44727b5
--- /dev/null
+++ b/doc/news.rst
@@ -0,0 +1,15 @@
+================
+News / Changelog
+================
+
+0.1 (alpha)
+===========
+(2012-11-22)
+
+Initial release of HyperKitty.
+
+* login using django user account / browserid / google openid / yahoo openid
+* use Twitter Bootstrap for stylesheets
+* show basic list info and metrics
+* show basic user profile
+* Add tags to message threads