pen-tracker/README.md
2026-06-13 23:53:34 -05:00

40 lines
No EOL
873 B
Markdown

# Pen Tracker
A simple fountain pen collection tracker.
## Installation
```bash
pip install .
```
## Data Storage
Pen data is stored in `~/.local/share/pen-tracker/pens.csv` by default, following XDG Base Directory specification. The directory is created automatically if it doesn't exist.
You can override the location by setting the `PEN_TRACKER_CSV` environment variable.
## Usage
### CLI
Interactive mode:
```bash
pen-tracker
```
Command-line mode:
```bash
pen-tracker add --make "Pilot" --model "Metropolitan" --nib "F"
pen-tracker list
pen-tracker export --output my_pens.json
```
## Features
- Track fountain pens with details like make, model, nib, ink, etc.
- CLI interface with interactive and command-line modes
- Data stored in CSV format
- Export to JSON
- Input validation for dates
- Configurable CSV path via PEN_TRACKER_CSV environment variable