Merge pull request #36 from UBC-MDS/develop

Develop -> Main / Completion of Milestone 2

Author: jiroamato

.gitignore

@@ -243,3 +243,9 @@ cython_debug/
 
 # Hatch-VCS
 _version.py
+
+# Coverage file from pytest
+.coverage
+
+# Development file from copier
+DEVELOPMENT.md

CHANGELOG.md

@@ -5,10 +5,32 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+##  [Unreleased]
 
-- Upcoming features and fixes
+- Upcoming features and fixes:
+  - CI integration via GitHub Workflows
+  - Publish on PyPi  
 
-## [0.1.0] - (1979-01-01)
+## [0.0.2] - (2026-01-17)
 
-- First release
+### Added
+
+- Added pandas dependency to pyproject.toml
+- `suggest_break` function that recommends break activities based on work duration and preferences (break type, duration, location, energy level)
+- `get_affirmation` function that returns motivational affirmations based on energy level and task type
+- `plan_pomodoro()` implementation for generating Pomodoro-style work/break schedules.
+- `prioritize_tasks()` function for ranking tasks by priority (either by importance or deadline)
+- Comprehensive test suite for `suggest_break`, `get_affirmation`, `plan_pomodoro`
+- Added `Testing` portion to the README.md
+- Added a brief description of the package in `src/deepwork/__init__.py`
+
+### Changed
+
+- Updated all docstring to be more comprehensive and include examples of usage.
+- Added `--cov-branch` flag under the [tool.hatch.envs.test.scripts] matrix in the `pyproject.toml` file
+
+## [0.0.1] - (2026-01-10)
+
+- First release:
+  - Create project structure for the software package
+  - Write function specifications and documentation

DEVELOPMENT.md

@@ -2,15 +2,15 @@
 
 |  |  |
 |------------------------------------|------------------------------------|
-| Package | [![PyPI Version](https://img.shields.io/badge/PyPI-v0.0.0-lightgrey.svg)](#) [![Python Versions](https://img.shields.io/badge/Python-3.8%2B-lightgrey.svg)](#) |
+| Package | [![PyPI Version](https://img.shields.io/badge/PyPI-v0.1.0-lightgrey.svg)](#) [![Python Versions](https://img.shields.io/badge/Python-3.10%2B-lightgrey.svg)](#) |
 | Meta | [![Code of Conduct](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md) |
 
 `deepwork` is a Python package for developer productivity that helps developers stay focused and energized throughout the workday. `deepwork` provides tools to plan focus (pomodoro) sessions, prioritize tasks, take effective breaks, and stay motivated with personalized affirmations. The perfect package for developers looking to optimize their workflow.
 
 ## Get Started
-
+> To install the latest release (latest tag) from GitHub, run the following:
 ``` bash
-$ pip install deepwork
+$ pip install git+https://github.com/UBC-MDS/deepwork@main
 ```
 
 ### Functions
@@ -31,12 +31,17 @@ This package contains four main functions:
 
 `deepwork` requires the following libraries:
 
+-   **Python 3.10+**: Required runtime environment.
 -   **Pandas**: Used for data manipulation and the structured table display of schedules and tasks.
+-   **pip**: Used for package installation.
 
 ## Usage
 
 ``` python
-from deepwork import get_affirmation, plan_pomodoro, prioritize_tasks, suggest_break
+from deepwork.affirmation import get_affirmation
+from deepwork.pomodoro import plan_pomodoro
+from deepwork.prioritize import prioritize_tasks
+from deepwork.breaks import suggest_break
 
 # Get a motivational affirmation
 affirmation = get_affirmation(name="Alice", mood="stressed", energy=4)
@@ -59,6 +64,26 @@ activity = suggest_break(minutes_worked=90, energy_level=4, break_type="active")
 print(activity['name'], "-", activity['description'])
 ```
 
+## Testing
+
+To run the tests for this package, clone the repository and install it with the test dependencies:
+
+1. Clone the repository:
+``` bash
+$ git clone https://github.com/UBC-MDS/deepwork
+```
+
+2. Install the package with test dependencies:
+```bash
+$ cd path/to/deepwork
+$ pip install -e ".[tests]"
+```
+
+3. Run tests accordingly:
+```bash
+$ pytest tests/ -v --cov=deepwork --cov-branch --cov-report=term-missing # shows a verbose output of tests
+```
+
 ## Python Ecosystem
 
 `deepwork` combines productivity and wellness features into a single cohesive library. While there are separate packages for individual features like [tomato-timer](https://pypi.org/project/tomato-timer/) for Pomodoro timing and various task management libraries, `deepwork` uniquely integrates focus session planning, task prioritization, break suggestions, and motivational affirmations into one package, specifically designed for developers. This holistic approach helps developers maintain both productivity and well-being without needing multiple tools.

README.md

@@ -36,7 +36,9 @@ classifiers = [
 # TODO: add keywords
 keywords = []
 # TODO: add dependencies
-dependencies = []
+dependencies = [
+    "pandas"
+]
 
 [project.urls]
 Homepage = "https://github.com/UBC-MDS/deepwork"
@@ -153,7 +155,7 @@ features = [
 python = ["3.10", "3.11", "3.12", "3.13"]
 
 [tool.hatch.envs.test.scripts]
-run = "pytest {args:--cov=deepwork --cov-report=term-missing --cov-report=xml}"
+run = "pytest {args:--cov=deepwork --cov-branch --cov-report=term-missing --cov-report=xml}"
 
 #--------------- Build and preview your documentation ---------------#
 

pyproject.toml

@@ -22,8 +22,14 @@
 # SOFTWARE.
 
 """
-Add a docstring here for the init module.
+deepwork: A Python package for developer productivity.
 
-This might include a very brief description of the package,
-its purpose, and any important notes.
+This package helps engineers optimize their workflow by providing tools to:
+- Plan focus sessions using Pomodoro and other time-blocking techniques
+- Prioritize tasks using weighted scoring or deadline-based methods
+- Take effective breaks with activity suggestions based on energy levels
+- Stay motivated with personalized developer-focused affirmations
+
+Designed for engineers looking to maintain focus, manage energy,
+and sustain productivity throughout the workday.
 """