================================================
Extract text from emails selected from mailboxes
================================================

.. contents::


Description
===========

This package provides a text extraction interface given directories of email files selected from mailboxes populated by an email client.

Specify selection rules for text by email source and attachment type and name.

Extract text from a set of emails.

Allow specific emails to be ignored when extracting text.


Installation Instructions
=========================

This package is not available on PyPI, or any other package index, but can be installed by typing

   python -m pip install --user --trusted-host solentware.co.uk --find-links http://solentware.co.uk/wheels.html emailextract

at the command prompt.

See pip documentation for alternatives and platform-specific points.

Then run 'python -m pip check' to identify other packages which need to be installed.


Run
===

The command to run this package is:

   python -m emailextract.emailextract

You may need to give the path and version of Python depending on your system's configuration:

   <path to python>/python<version> -m emailextract.emailextract

   For example

      C:\\Python33\\python -m emailextract.emailextract

         on Microsoft Windows or

      python3.4 -m emailextract.emailextract

         on Unix-like systems.

Or use the facilities of your desktop (Microsoft Windows, GNOME, KDE, ...) to set up a convenient way of starting emailextract. 


Restrictions
============

At most one email per sender per second, looking at the date sent, is allowed.


Notes
=====

The current implementation does just enough to support the `ChessResults`_ package.

The configuration file editor interface is almost unusable.


.. _Python: https://python.org
.. _pip: https://packaging.python.org/installing
.. _ChessResults: http://solentware.co.uk/grading.html
