Project Planner
===============

Project Planner is a small Python planning tool for validating project task
definitions, printing dependency-aware schedules, importing planner-style Word
documents as YAML drafts, exporting plans to Word, SVG, PDF, and PowerPoint files, and producing
SVG or PowerPoint Gantt charts.

The source repository is ``git@re-git.lanl.gov:tpp/planner.git``.

.. toctree::
   :maxdepth: 2
   :caption: Contents

   quickstart
   development-data
   schema
   composite
   cli
   configuration
   funding
   export-options
   api

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

Use Python 3.11 or newer.

Install from PyPI
~~~~~~~~~~~~~~~~~

If you only want to use the planner, create and activate a virtual environment
and install the published package. No repository checkout is needed:

.. code-block:: bash

   python3 -m venv .venv
   source .venv/bin/activate
   python -m pip install tuxfan-planner
   planner --help

Activate ``.venv`` again when starting a new shell.

Install from source
~~~~~~~~~~~~~~~~~~~

For development or to use a local checkout, run these commands from the
repository root:

.. code-block:: bash

   python3 -m venv .venv
   source .venv/bin/activate
   python -m pip install -e .
   planner --help

Install the documentation extra, which includes Sphinx and the Furo theme,
when you want to build this documentation:

.. code-block:: bash

   python -m pip install -e ".[docs]"

Build the HTML documentation with:

.. code-block:: bash

   python -m sphinx docs docs/_build/html
