Added some documentation

docs/Makefile

@@ -0,0 +1,177 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+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 "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  xml        to make Docutils-native XML files"
+	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
+	@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/RIPEAtlasToolsMagellan.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/RIPEAtlasToolsMagellan.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/RIPEAtlasToolsMagellan"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/RIPEAtlasToolsMagellan"
+	@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."
+
+latexpdfja:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through platex and dvipdfmx..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+	@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."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+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."
+
+xml:
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+	@echo
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+	@echo
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

docs/_static/custom.css

@@ -0,0 +1,14 @@
+/* override table width restrictions */
+@media screen and (min-width: 767px) {
+
+  .wy-table-responsive table td {
+    /* !important prevents the common CSS stylesheets from
+       overriding this as on RTD they are loaded after this stylesheet */
+    white-space: normal !important;
+  }
+
+  .wy-table-responsive {
+    overflow: visible !important;
+  }
+
+}

docs/changelog.rst

@@ -1,6 +1,8 @@
 Changelog
 #########
 
+* 0.0.3
+    * Added basic tagging
 * 0.0.2
     * Added language detection
     * Added datestamps to ``document_exporter``.

docs/conf.py

@@ -0,0 +1,364 @@
+# -*- coding: utf-8 -*-
+#
+# Paperless documentation build configuration file, created by
+# sphinx-quickstart on Mon Oct 26 18:36:52 2015.
+#
+# 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
+import os
+
+__version__ = None
+exec(open("../src/paperless/version.py").read())
+
+
+# Believe it or not, this is the officially sanctioned way to add custom CSS.
+def setup(app):
+    app.add_stylesheet("custom.css")
+
+# 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 = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.todo',
+    'sphinx.ext.pngmath',
+    'sphinx.ext.viewcode',
+]
+
+# 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'Paperless'
+copyright = u'2015, Daniel Quinn'
+
+# 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.
+#
+
+#
+# If the build process ever explodes here, it's because you've set the version
+# number in paperless.version to a tuple with 3 numbers in it.
+#
+
+# The short X.Y version.
+version = ".".join([str(_) for _ in __version__[:2]])
+# The full version, including alpha/beta/rc tags.
+release = ".".join([str(_) for _ in __version__[:3]])
+
+# 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']
+
+# 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 = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+#keep_warnings = False
+
+
+# -- 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']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+#html_extra_path = []
+
+# 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 = 'paperless'
+
+
+#
+# Attempt to use the ReadTheDocs theme.  If it's not installed, fallback to
+# the default.
+#
+
+try:
+    import sphinx_rtd_theme
+    html_theme = "sphinx_rtd_theme"
+    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+except ImportError:
+    pass
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+  ('index', 'paperless.tex', u'Paperless Documentation',
+   u'Daniel Quinn', '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
+
+# 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', 'paperless', u'Paperless Documentation',
+     [u'Daniel Quinn'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+  ('index', 'Paperless', u'Paperless Documentation',
+   u'Daniel Quinn', 'paperless', 'Scan, index, and archive all of your paper documents.',
+   'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+#texinfo_no_detailmenu = False
+
+
+# -- Options for Epub output ----------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = u'Paperless'
+epub_author = u'Daniel Quinn'
+epub_publisher = u'Daniel Quinn'
+epub_copyright = u'2015, Daniel Quinn'
+
+# The basename for the epub file. It defaults to the project name.
+#epub_basename = u'Paperless'
+
+# The HTML theme for the epub output. Since the default themes are not optimized
+# for small screen space, using the same theme for HTML and epub output is
+# usually not wise. This defaults to 'epub', a theme designed to save visual
+# space.
+#epub_theme = 'epub'
+
+# The language of the text. It defaults to the language option
+# or en if the language is not set.
+#epub_language = ''
+
+# The scheme of the identifier. Typical schemes are ISBN or URL.
+#epub_scheme = ''
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#epub_identifier = ''
+
+# A unique identification for the text.
+#epub_uid = ''
+
+# A tuple containing the cover image and cover page html template filenames.
+#epub_cover = ()
+
+# A sequence of (type, uri, title) tuples for the guide element of content.opf.
+#epub_guide = ()
+
+# HTML files that should be inserted before the pages created by sphinx.
+# The format is a list of tuples containing the path and title.
+#epub_pre_files = []
+
+# HTML files shat should be inserted after the pages created by sphinx.
+# The format is a list of tuples containing the path and title.
+#epub_post_files = []
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']
+
+# The depth of the table of contents in toc.ncx.
+#epub_tocdepth = 3
+
+# Allow duplicate toc entries.
+#epub_tocdup = True
+
+# Choose between 'default' and 'includehidden'.
+#epub_tocscope = 'default'
+
+# Fix unsupported image types using the PIL.
+#epub_fix_images = False
+
+# Scale large images.
+#epub_max_image_width = 0
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#epub_show_urls = 'inline'
+
+# If false, no index is generated.
+#epub_use_index = True
+
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'http://docs.python.org/': None}

docs/index.rst

@@ -0,0 +1,33 @@
+.. _index:
+
+Paperless
+=========
+
+Scan, index, and archive all of your paper documents.  Say goodbye to paper.
+
+
+.. _index-why-this-exists:
+
+Why This Exists
+===============
+
+Paper is a nightmare.  Environmental issues aside, there's no excuse for it in
+the 21st century.  It takes up space, collects dust, doesn't support any form of
+a search feature, indexing is tedious, it's heavy and prone to damage & loss.
+
+I wrote this to make "going paperless" easier.  I wanted to be able to feed
+documents right from the post box into the scanner and then shred them so I
+never have to worry about finding stuff again.  Perhaps you might find it useful
+too.
+
+
+Contents
+========
+
+.. toctree::
+   :maxdepth: 2
+
+   requirements
+   setup
+   utilities
+   changelog

docs/requirements.rst

@@ -0,0 +1,36 @@
+.. _requirements:
+
+Requirements
+============
+
+You need a Linux machine or Unix-like setup (theoretically an Apple machine
+should work) that has the following software installed on it:
+
+* Python3 (with development libraries, pip and virtualenv)
+* Tesseract
+* Imagemagick
+
+If you're not working on a virtual environment (like Vagrant or Docker), you
+should probably be using a virtualenv, but that's your call.  The reasons why
+you might choose a virtualenv or not aren't really within the sope of this
+document.
+
+In addition to the above, there are a number of Python requirements, all of
+which are listed in ``requirements.txt``.  They will be installed automatically
+with ``pip`` as part of the installation process.
+
+
+.. _requirements-documentation:
+
+Documentation
+-------------
+
+As generation of the documentation is not required for use of *Paperless*,
+dependencies for this process are not included in ``requirements.txt``.  If
+you'd like to generate your own docs locally, you'll need to:
+
+.. code:: bash
+
+    $ pip install sphinx
+
+and then cd into the ``docs`` directory and type ``make html``.

docs/setup.rst

@@ -0,0 +1,112 @@
+.. _setup:
+
+Setup
+=====
+
+Paperless isn't a very complicated app, but there are a few components, so some
+basic documentation is in order.  If you go follow along in this document and
+still have trouble, please open an `issue on GitHub`_ so I can fill in the gaps.
+
+.. _issue on GitHub: https://github.com/danielquinn/paperless/issues
+
+
+.. _setup-download:
+
+Download
+--------
+
+The source is currently only available via GitHub, so grab it from there, either
+by using ``git``:
+
+.. code:: bash
+
+    $ git clone github.com:danielquinn/paperless.git
+    $ cd paperless
+
+or just download the tarball and go that route:
+
+.. code:: bash
+
+    $ wget https://github.com/danielquinn/paperless/archive/master.zip
+    $ unzip master.zip
+    $ cd paperless-master
+
+
+.. _setup-installation:
+
+Installation & Configuration
+----------------------------
+
+You can go two routes with setting up and running Paperless.  The *Vagrant*
+route is quick & easy, but means you're running a VM which comes with memory
+consumption etc.  Alternatively the standard, "bare metal" approach is a little
+more complicated.
+
+
+.. _setup-installation-standard:
+
+Standard (Bare Metal)
+.....................
+
+1. Install the requirements as per the :ref:`requirements <requirements>` page.
+2. Change to the ``src`` directory in this repo.
+3. Edit ``paperless/settings.py`` and be sure to set the values for
+   ``CONSUMPTION_DIR`` and ``PASSPHRASE`` at the bottom of the file.
+4. Initialise the database with ``./manage.py migrate``.
+5. Create a user for your Paperless instance with
+   ``./manage.py createsuperuser``. Follow the prompts to create your user.
+6. Start the webserver with ``./manage.py runserver``.
+   You should now be able to visit your (empty) `Paperless webserver`_ at
+   ``127.0.0.1:8000``.  You can login with the user/pass you created in #5.
+7. In a separate window, change to the ``src`` directory in this repo again, but
+   this time, you should start the consumer script with
+   ``./manage.py document_consumer``.
+8. Scan something.  Put it in the ``CONSUMPTION_DIR``.
+9. Wait a few minutes
+10. Visit the document list on your webserver, and it should be there, indexed
+    and downloadable.
+
+.. _Paperless webserver: http://127.0.0.1:8000
+
+
+.. _setup-installation-vagrant:
+
+Vagrant Method
+..............
+
+1. Install `Vagrant`_.  How you do that is really between you and your OS.
+2. Run ``vagrant up``.  An instance will start up for you.  When it's ready and
+   provisioned...
+3. Run ``vagrant ssh`` and once inside your new vagrant box, edit
+   ``/opt/paperless/src/paperless/settings.py``.  Specifically, you need to make
+   sure that you set values for ``CONSUMPTION_DIR`` and ``PASSPHRASE`` at the
+   bottom of the file.
+4. Initialise the database with ``/opt/paperless/src/manage.py migrate``.
+5. Still inside your vagrant box, create a user for your Paperless instance with
+   ``/opt/paperless/src/manage.py createsuperuser``. Follow the prompts to
+   create your user.
+6. Start the webserver with ``/opt/paperless/src/manage.py runserver 0.0.0.0:8000``.
+   You should now be able to visit your (empty) `Paperless webserver`_ at
+   ``172.28.128.4:8000``.  You can login with the user/pass you created in #5.
+7. In a separate window, run ``vagrant ssh`` again, but this time once inside
+   your vagrant instance, you should start the consumer script with
+   ``/opt/paperless/src/manage.py document_consumer``.
+8. Scan something.  Put it in the ``CONSUMPTION_DIR``.
+9. Wait a few minutes
+10. Visit the document list on your webserver, and it should be there, indexed
+    and downloadable.
+
+.. _Vagrant: https://vagrantup.com/
+.. _Paperless server: http://172.28.128.4:8000
+
+
+.. _making-things-a-little-more-permanent:
+
+Making Things a Little more Permanent
+-------------------------------------
+
+Once you've tested things and are happy with the work flow, you can automate the
+process of starting the webserver and consumer automatically.  If you're running
+on a bare metal system that's using Systemd, you can use the service unit files
+in the ``scripts`` directory to set this up.  If you're on a SysV or other
+startup system (like the Vagrant box), then you're currently on your own.

docs/utilities.rst

@@ -0,0 +1,107 @@
+.. _utilities:
+
+Utilities
+=========
+
+There's basically three utilities to *Paperless*: the webserver, consumer, and
+if needed, the exporter.  They're all detailed here.
+
+
+.. _utilities-webserver:
+
+The Webserver
+-------------
+
+At the heart of it, *Paperless* is a simple Django webservice, and the entire
+interface is based on Django's standard admin interface.  Once running, visiting
+the URL for your service delivers the admin, through which you can get a
+detailed listing of all available documents, search for specific files, and
+download whatever it is you're looking for.
+
+
+.. _utilities-webserver-howto:
+
+How to Use It
+.............
+
+The webserver is started via the ``manage.py`` script:
+
+.. code:: bash
+
+    $ /path/to/paperless/src/manage.py runserver
+
+By default, the server runs on localhost, port 8000, but you can change this
+with a few arguments, run ``manage.py --help`` for more information.
+
+Note that this command runs continuously, so exiting it will mean your webserver
+disappears.  If you want to run this full-time (which is kind of the point)
+you'll need to have it start in the background -- something you'll need to
+figure out for your own system.  To get you started though, there are Systemd
+service files in the ``scripts`` directory.
+
+
+.. _utilities-consumer:
+
+The Consumer
+------------
+
+The consumer script runs in an infinite loop, constantly looking at a directory
+for PDF files to parse and index.  The process is pretty straightforward:
+
+1. Look in ``CONSUMPTION_DIR`` for a PDF.  If one is found, go to #2.  If not,
+   wait 10 seconds and try again.
+2. Parse the PDF with Tesseract
+3. Create a new record in the database with the OCR'd text
+4. Encrypt the PDF and store it in the ``media`` directory under
+   ``documents/pdf``.
+5. Go to #1.
+
+
+.. _utilities-consumer-howto:
+
+How to Use It
+.............
+
+The consumer is started via the ``manage.py`` script:
+
+.. code:: bash
+
+    $ /path/to/paperless/src/manage.py document_consumer
+
+This starts the service that will run in a loop, consuming PDF files as they
+appear in ``CONSUMPTION_DIR``.
+
+Note that this command runs continuously, so exiting it will mean your webserver
+disappears.  If you want to run this full-time (which is kind of the point)
+you'll need to have it start in the background -- something you'll need to
+figure out for your own system.  To get you started though, there are Systemd
+service files in the ``scripts`` directory.
+
+
+.. _utilities-exporter:
+
+The Exporter
+------------
+
+Tired of fiddling with *Paperless*, or just want to do something stupid and are
+afraid of accidentally damaging your files?  You can export all of your PDFs
+into neatly named, dated, and unencrypted.
+
+
+.. _utilities-exporter-howto:
+
+How to Use It
+.............
+
+This too is done via the ``manage.py`` script:
+
+.. code:: bash
+
+    $ /path/to/paperless/src/manage.py document_exporter /path/to/somewhere
+
+This will dump all of your PDFs into ``/path/to/somewhere`` for you to do with
+as you please.  The naming scheme on export is identical to that used for
+import, so should you can now safely delete the entire project directly,
+database, encrypted PDFs and all, and later create it all again simply by
+running the consumer again and dumping all of these files into
+``CONSUMPTION_DIR``.

src/paperless/version.py

@@ -0,0 +1 @@
+__version__ = (0, 0, 3)