Skip to main content

A CLI-based Task Scheduling Application

Project description

Task Scheduler

A CLI-based task scheduling application with interactive mode and visualization capabilities.

Features

  • Create/manage multiple independent schedulers
  • Define time slots with start/end times
  • Create tasks with deadlines, durations, and descriptions
  • Hierarchical task management with subtasks
  • Multiple visualization modes:
  • Gantt chart view
  • Calendar view
  • progress bars
  • deadline warnings
  • Automatic task scheduling with deadline awareness
  • Interactive terminal UI
  • Docker container support
  • JSON-based persistent storage

Installation

Local Installation (pip)

git clone https://github.com/yourusername/task_scheduler.git
cd task_scheduler
pip install -e .

Docker Installation

# Build image
docker build -t task-scheduler .

# Run with default command
docker run -it task-scheduler

# Run with specific command
docker run -it task-scheduler view_schedule MySchedule

Basic Usage

CLI Commands

Create new scheduler

task-scheduler create --name MySchedule

Add time slot

task-scheduler add_time_slot MySchedule
--start_time 2024-03-01T09:00
--end_time 2024-03-01T11:00

Add task with subtasks

task-scheduler add_task MySchedule
--name "Project X"
--description "Main project"
--duration 300
--deadline 2024-03-15T17:00

Generate schedule

task-scheduler schedule_tasks MySchedule

View visualizations

task-scheduler view_gantt MySchedule task-scheduler view_calendar MySchedule --month 3

Interactive Mode

Launch with:

task-scheduler interactive MySchedule

Controls:

↑/↓ - Navigate tasks

Enter - Select task

a - Add new task

m - Move task mode

q - Quit

Features:

Visual task hierarchy

Vim-based task editing

Drag-and-drop reorganization

Real-time progress updates

Color-coded deadlines

Controls:

Navigation

↑/↓ - Navigate items in focused panel Tab - Switch between task/time slot panels clicking on a task - selects the task

Actions

Enter - Select task/time slot a - Add new task/time slot (depending on focused panel) m - Enter move mode (tasks) / Modify slot (time slots)

General

q - Quit application

Key Features:

Dual-Pane Interface

📋 Left Panel - Task Hierarchy:
  • Visual tree structure with nested subtasks
⏱️ Right Panel - Time Slot Management:
  • Chronological schedule view
  • Duration calculations with time slot validation
  • Enhanced Editing
  • In-line time slot modification with instant validation
  • Drag-and-drop reorganization (tasks)
  • Keyboard-based time slot adjustments

New Features

  • Split-screen workflow management
  • Cross-panel task/time slot associations
  • Real-time schedule validation
  • Visual focus indicators (highlighted panel borders)
  • Smart time slot sorting and gap detection

Feedback & Safety

  • Instant save confirmation toasts
  • Undo/redo stack for critical operations

Data Format

data format for information fully describing the scheduler instance - JSON

example:

{
  "schedule_name": "MySchedule",
  "time_slots": [
    {
      "start_time": "2024-03-01T09:00:00",
      "end_time": "2024-03-01T11:00:00"
    }
  ],
  "tasks": [
    {
      "name": "Design Phase",
      "description": "Initial design work",
      "deadline": "2024-03-05T17:00:00",
      "duration": 360,
      "completion": 45,
      "subtasks": [
        {
          "name": "UI Mockups",
          "duration": 120,
          "completion": 75
        }
      ]
    }
  ]
}

Visualisation Examples

Gantt Chart

task-scheduler view_gantt MySchedule

Calendar View

task-scheduler view_calendar MySchedule --month 3

Task Progress

task-scheduler view_task MySchedule "Design Phase"

output:

=== Task Details: Design Phase ===

Name: Design Phase Deadline: 2024-03-05T17:00:00 Completion: 45.0% Duration: 360 min Subtasks: ['UI Mockups'] Description: Initial design work

Testing

python -m pytest tests/ -v

Docker Support

The Docker image includes:

Pre-configured Python environment

Automatic dependency installation

Persistent data storage

Built-in test execution

To mount local data directory:

To build the docker image run:

docker build -t task-scheduler .
docker run -v $(pwd)/data:/app/data -it task-scheduler

Requirements

Python 3.7+

colorama

urwid

pytest (for testing)

Contributing

Fork the repository

Create your feature branch (git checkout -b feature/awesome-feature)

Commit your changes (git commit -am 'Add awesome feature')

Push to the branch (git push origin feature/awesome-feature)

Open a Pull Request

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

task_scheduler_x-1.0.7.tar.gz (24.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

task_scheduler_x-1.0.7-py3-none-any.whl (25.2 kB view details)

Uploaded Python 3

File details

Details for the file task_scheduler_x-1.0.7.tar.gz.

File metadata

  • Download URL: task_scheduler_x-1.0.7.tar.gz
  • Upload date:
  • Size: 24.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.1

File hashes

Hashes for task_scheduler_x-1.0.7.tar.gz
Algorithm Hash digest
SHA256 81f098564e91c2385268e36539eae64e9b6639201cfb257bcd6ea7096d058595
MD5 1fa3c90fd72d7b8486bd7f263184eb98
BLAKE2b-256 abe9b9e9d8fab63286b2f732b185e915a3a2ae176022580ecc5642c3a043aee1

See more details on using hashes here.

File details

Details for the file task_scheduler_x-1.0.7-py3-none-any.whl.

File metadata

File hashes

Hashes for task_scheduler_x-1.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 9697b10c97f3d5a3da23a0a41d9b6de4657f5d432c4cbdf65a2ed197c4400105
MD5 b8343f1b3d2eb01916fc5c06cac2c415
BLAKE2b-256 ad79da8677232d06e7a8276e7cddf200805f9f9a9b989da7e03dfb8e4a6be7d9

See more details on using hashes here.

Supported by

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