Metadata-Version: 2.4
Name: taskpulse-24
Version: 0.1.0
Summary: A small, dependency-free task prioritizer and daily planner.
Author: TaskPulse contributors
License: MIT License
        
        Copyright (c) 2026 TaskPulse contributors
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
        
Project-URL: Homepage, https://github.com/OttoHui/taskpulse
Project-URL: Repository, https://github.com/OttoHui/taskpulse
Project-URL: Documentation, https://github.com/OttoHui/taskpulse#readme
Keywords: productivity,planning,tasks,scheduling
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: dev
Requires-Dist: pytest>=8; extra == "dev"
Requires-Dist: ruff>=0.6; extra == "dev"
Dynamic: license-file

# TaskPulse

TaskPulse is a small, dependency-free Python package that turns a task list
into a focused daily plan. It is designed for students and small project teams
who want transparent prioritization without sending personal data to a service.

## Project team

**Group 24 (6/6 members)**

- Tsz Hei CHUI
- Fong Kwan HUI
- David KWONG
- Sik Man LAM
- Hong Shing WONG
- Chun Hin YIU

## Why it exists

Most task apps either require a hosted account or hide prioritization behind a
complex interface. TaskPulse keeps the algorithm inspectable:

1. importance is explicit (`LOW`, `MEDIUM`, or `HIGH`);
2. approaching due dates add urgency;
3. shorter tasks win ties, making plans easier to finish;
4. tasks are packed into days without splitting a task across sessions.

The result is useful for study plans, sprint preparation, and a one-minute
project demonstration.

## Install

```bash
pip install taskpulse-24
```

For local development:

```bash
git clone https://github.com/OttoHui/taskpulse.git
cd taskpulse
pip install -e ".[dev]"  # or: pip install -e .
pytest
```

## Python API

```python
from datetime import date
from taskpulse import Priority, Task, schedule

tasks = [
    Task("Write project abstract", 45, Priority.HIGH, date(2026, 10, 10)),
    Task("Review references", 30, Priority.MEDIUM),
]

plan = schedule(tasks, daily_minutes=60, start=date(2026, 10, 7))
for day, items in plan.items():
    print(day, [item.title for item in items])
```

## Command line

Create `tasks.csv`:

```csv
title,minutes,priority,due
Write project abstract,45,3,2026-10-10
Review references,30,2,
```

Then run:

```bash
taskpulse tasks.csv --daily-minutes 60
```

## Project and collaboration

Suggested team split for Group 24:

- **Tsz Hei CHUI:** project coordination, requirements, and final integration.
- **Fong Kwan HUI:** core models, prioritization, and scheduling logic.
- **David KWONG:** command-line interface and user experience.
- **Sik Man LAM:** tests, edge cases, and quality checks.
- **Hong Shing WONG:** documentation, examples, and PyPI metadata.
- **Chun Hin YIU:** demo, presentation wiki, and release verification.

Make small commits by feature and review each other's pull requests. The
published distribution is named `taskpulse-24`; its import name remains
`taskpulse`.

## One-minute demonstration

1. Show the two-row CSV (10 seconds).
2. Run `taskpulse tasks.csv --daily-minutes 60` (15 seconds).
3. Explain that priority and due date determine order, while capacity determines
   the day (20 seconds).
4. Show the equivalent Python API and mention that no external service or
   dependency is required (15 seconds).

## Roadmap

- optional weekend skipping;
- JSON input/output;
- calendar export;
- configurable scoring strategies.
