https://github.com/asuntx/habitpy
a complete CLI habit tracker written in python
https://github.com/asuntx/habitpy
habit-tracker habits track
Last synced: 3 months ago
JSON representation
a complete CLI habit tracker written in python
- Host: GitHub
- URL: https://github.com/asuntx/habitpy
- Owner: asuntx
- License: mit
- Created: 2025-05-28T00:29:49.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-08-09T15:14:31.000Z (10 months ago)
- Last Synced: 2026-01-14T09:30:08.027Z (5 months ago)
- Topics: habit-tracker, habits, track
- Language: Python
- Homepage:
- Size: 238 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# HabitPy
**Track your habits, analyze your progress, and stay motivated—all from your terminal!**
## Features
- 📅 **Daily & Weekly Tracking:** Log your habits (only numbers)
- ✏️ **Custom Habits:** Add, show, or delete any habit you want to track.
- 📈 **Visualize Progress:** Instantly generate beautiful graphs (with dark mode!) for your week, month, or year.
- 🎉 **Motivational Cheers:** Get random motivational messages to keep you going.
- 📤 **Export Data:** Export all your habit data to CSV for use in Excel, Sheets, or anywhere else.
- 🛠️ **Easy Reset:** Reset your data and start fresh anytime.
---
## Installation
### 🔧 Prerequisites
Before building or running HabitPy, create a virtual environment and install dependencies:
```bash
# Clone the repo
git clone https://github.com/asuntx/habitpy.git
cd habitpy
# Create and activate virtual environment
python -m venv .venv
source .venv/bin/activate # On Windows: .venv\Scripts\activate
# Install dependencies
pip install .
```
---
### 🚀 Option 1: Build and Install from Source (Recommended)
note: \* is the version and name it might change so just copy the name of the whl file
```bash
# Build the distribution
python -m build
# Install the built package globally
pip install dist/habitpy-*.whl
```
---
### ⚡ Option 2: Use pipx (Recommended for CLI tools)
```bash
# Build the distribution
python -m build
# Install with pipx (ensures global availability)
pipx install dist/habitpy-*.whl
```
---
### 🧪 Option 3: Development Installation
#### With pip (editable mode)
```bash
# Already inside .venv
pip install -e .
```
#### With uv
```bash
uv sync
uv run habitpy setup
```
#### With pipx (editable mode)
```bash
pipx install -e .
```
---
## 🕹️ Usage
First, set up your tracker:
```bash
habitpy setup
```
Then, use the commands:
- `habitpy track ` — Log today’s habits
- `habitpy create ` — Add a new habit
- `habitpy show` — List all habits
- `habitpy delete ` — Remove a habit
- `habitpy graph week|month|year` — Visualize progress
- `habitpy export` — Export data to CSV
- `habitpy reset` — Delete all data and start over
---
[](https://ko-fi.com/W7W318WNN8)
---