=========================
openpyxl-redmine overview
=========================

Overview
--------

The openpyxl-redmine package provides interface glue between a workflow
Excel representations and its Redmine representation. The former is a flat
table and the latter a tree graph of tasks.

Aimed for package users are PTC and PEPs, which are described elsewhere.

Package directory structure
---------------------------

The package directory structure is:

::

    openpyxl-redmine
        \--- docs
        \--- src
             \--- common
             \--- config
             \--- pep
             \--- ptc
             \--- tests
                  \--- integration
                       \--- templates
                  \--- unit

where:

* docs: rst documentation
* common: base classes
* config: application configuration files
* pep: applications primarily for PEPs
* ptc: applications primarily for PTC
* integration: Table and Redmine integration tests
* templates: Tables used during integartioin tests
* unit: unit tests

Installation
------------

Installation requirements are listed in the top-level requirements.txt file.

Console-scripts defined in the top-level setup.py file are used to run
applications.