Skip to main content

Python library for plan projects

Project description

pjplan: Python library for project planning and analysis

What is it?

pjplan turns your Jupyter Notebook into project management software. This Python package gives you a simple API with following features:

  • Describe Work Burn-down Structure (WBS) of your project in code or load it from external source.
  • Manipulate tasks: link them as successors/predecessors, find, delete, reorder, etc. A lot of batch operations are supported via simple commands.
  • Assign resources and estimates to tasks
  • Define work calendars for each resource
  • Calculate project schedule in several ways
  • Find critical path
  • Visualize WBS as Gantt or Network diagram
  • Save/Load your WBS to/from csv files
  • Export WBS to pandas

Why to use it?

There are several use cases for pjplan:

  • Work with project plan as code with your favourite IDE, VSC, etc.
  • Load tasks data from your tracker (Jira, Asure Devops, Trello, etc.) to pjplan, link/modify/reorder/delete tasks using rich pjplan API, then create schedule and Gantt for them.
  • Create several schedules for same project and find optimal one.

Where to use it?

pjplan created specially for use inside Jupyter Notebook or similar software. All library objects (WBS, Task, Schedule, Calendar) have great visualisations so you can easily work with them in notebooks.

But, of course, you can use pjplan in any other python applications.

Installation

pip install pjplan

Getting started

Let's define simple project WBS:

from pjplan import WBS, Task

with WBS() as prj:
    prj // Task(1, 'Task 1', estimate=40, resource_name='Developer')
    prj // Task(2, 'Task 2', predecessors=[prj[1]], estimate=20, resource_name='Developer')
    with prj // Task(3, 'Task 3') as t3:
        t3 // Task(4, 'Task 4', predecessors=[prj[2]], estimate=100, resource_name='Tester')
        t3 // Task(5, 'Task 5', predecessors=[prj[2]], estimate=50, resource_name='Tester')

Let's define resources:

from pjplan import Resource, WeeklyCalendar

work_calendar = WeeklyCalendar(days=[0,1,2,3,4], units_per_day=8)

developer = Resource(name='Developer', calendar=work_calendar)
tester = Resource(name='Tester', calendar=work_calendar)

Now we can create schedule for our project:

from datetime import datetime
from pjplan import ForwardScheduler

schedule = ForwardScheduler(
    start=datetime.now(), 
    resources=[developer, tester]
).calc(prj)

visualise it as Mermaid Gantt:

from pjplan import MermaidGantt

MermaidGantt(schedule.schedule)

Mermaid Gantt

or Network:

from pjplan import MermaidNetwork

MermaidNetwork(schedule.schedule)

Mermaid Network

save schedule to csv:

from pjplan import write_csv

write_csv(schedule.schedule, "schedule.csv")

More examples

More examples you can find at examples directory.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pjplan-0.0.12.tar.gz (164.1 kB view hashes)

Uploaded Source

Built Distribution

pjplan-0.0.12-py3-none-any.whl (32.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page