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.
Contents
- Quick Start
- Development Data
- Plan Schema
- Top-Level Metadata
- Deliverables
- Milestones
- Task Defaults
- Task Fields
- Multi-Part Tasks
- Validation
- Strict Field Names
- Task Categories
- Typed Funding
- Derived Task Cost
- Funding code defaults
- Typed funding ranges
- Covered funding
- Task-date funding ranges
- Rates-file code identifiers
- Implicit multipart coverage shares
- Composite YAML Plans
- Command Line Interface
- Help Topics
- Parent-only plan exports
- Paging long output
- Commands
- Object List Views
- Filtering List Output with
--only - Environment Variables
- Exit Status
- Examples
- Input Integrity
- Deliverable inspection
- General Configuration
- Default Full-Plan Listing
- Project-Year Funding
- Configured List Presentation
- Metadata presentation
- Activity migration
- Execution description formatting
- Scoped export spacing
- Generated-number headings
- Project Dependency and Risk Views
- Parent summaries in task lists
- Nested plan organization and export placement
- Export selection containers
- Word/PDF final table pagination
- Priority Schema Migration
- Editing a plan entry
- Renaming IDs and references
- Adding entries
- Removing entries
- Text width
- Staff Funding
- Summary Markdown
- Coded Staff Allocations
- Task Cost
- Labor funding code selection
- Funding range shorthand
- Shared task funding
- Funding limited to task dates
- Offline documentation
- Rates code validation
- Child funding shares
- General Configuration
- Funding and Staff Costs
- Annual and typed funding
- Rates and staff availability
- Annual and duration modes
- Totals, authoring and exports
- Task Cost Output
- Funding across the plan’s fiscal range
- Activity funding codes
- Funding covered by another task
- Funding across a task’s date range
- Implicit shares of a multipart parent’s funding
- Export Options
- Multipart Parent Summaries
- Output Standards And Page Layout
- Separate Rules By Standard
- Selecting Content
- Nested Fields
- Task Lines And Field Styles
- Milestone And Deliverable Instructions
- Table Content
- Table Presentation
- Narrative Formatting And Import
- Migration
- PDF And PowerPoint
- Shared metadata styles and automatic colors
- Activity definitions and shared object formatting
- Execution description headings
- Per-element spacing
- Generated-number heading punctuation
- Project Dependencies and Consolidated Risks
- Summary Emphasis
- Python API
- Configuration
- Loader
- Models
- Deadline Assessments
- Export Options
- Exporters
- PowerPoint Plans
- Word Import
- Object Listings
- Gantt Exporters
- Terminal Planning Documents
- Staff Funding
- Task Cost Estimates
- Funding range context
- Funding coverage
- Task-date funding range context
- Rates code validation
- Implicit parent attribution
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:
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:
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:
python -m pip install -e ".[docs]"
Build the HTML documentation with:
python -m sphinx docs docs/_build/html