feat: Implement CLI and TUI for Fountain Pen Tracker
- Added CLI functionality for adding, editing, viewing, and deleting fountain pens. - Introduced TUI using Textual for a more interactive experience. - Created Pen and PenTracker classes to manage pen data and CSV storage. - Implemented input validation for date fields. - Added export functionality to JSON format. - Updated project version to 0.2.0. - Added unit tests for PenTracker functionality.
This commit is contained in:
Don Harper
parent
1a12e6d3c5
commit
51a1697c83
18 changed files with 866 additions and 166 deletions
0
build/lib/pen_tracker/__init__.py
Normal file
0
build/lib/pen_tracker/__init__.py
Normal file
248
build/lib/pen_tracker/cli.py
Normal file
248
build/lib/pen_tracker/cli.py
Normal file
|
|
@ -0,0 +1,248 @@
|
|||
import os
|
||||
import csv
|
||||
import argparse
|
||||
import json
|
||||
from datetime import datetime
|
||||
from .engine import PenTracker, Pen
|
||||
|
||||
def validate_date(date_str: str) -> bool:
|
||||
"""Validate date in YYYY-MM-DD format."""
|
||||
if date_str == "N/A":
|
||||
return True
|
||||
try:
|
||||
datetime.strptime(date_str, '%Y-%m-%d')
|
||||
return True
|
||||
except ValueError:
|
||||
return False
|
||||
|
||||
class CLITracker(PenTracker):
|
||||
|
||||
def add_pen(self):
|
||||
print("\n--- Add New Fountain Pen ---")
|
||||
new_pen_data = {}
|
||||
fields = [
|
||||
("Make", "Make"), ("Model", "Model"), ("Date Purchased (YYYY-MM-DD)", "Date-Purchased"),
|
||||
("Vendor", "Vendor"), ("Nib Size", "Nib"), ("Nib Material", "Nib-Material"),
|
||||
("Body Material", "Body"), ("Cap Material", "Cap"), ("Postable", "Post"),
|
||||
("Current Ink", "Current-Ink"), ("Inked Date (YYYY-MM-DD)", "Inked-date"), ("Notes", "Notes")
|
||||
]
|
||||
|
||||
for label, key in fields:
|
||||
while True:
|
||||
value = input(f"Enter {label}: ").strip()
|
||||
if not value:
|
||||
value = "N/A"
|
||||
break
|
||||
if key in ['Date-Purchased', 'Inked-date']:
|
||||
if validate_date(value):
|
||||
break
|
||||
else:
|
||||
print("Invalid date format. Use YYYY-MM-DD.")
|
||||
else:
|
||||
break
|
||||
new_pen_data[key] = value
|
||||
|
||||
# Map to Pen fields
|
||||
mapped_data = {self.key_map.get(k, k): v for k, v in new_pen_data.items()}
|
||||
new_pen = Pen(**mapped_data)
|
||||
self.pens.append(new_pen)
|
||||
self.save_data()
|
||||
print("\n[✔] Pen added successfully to Pens.csv!")
|
||||
|
||||
def edit_pen(self):
|
||||
"""Allows the user to select a pen and modify specific fields."""
|
||||
if not self.pens:
|
||||
print("\n[!] No pens available to edit.")
|
||||
return
|
||||
|
||||
# Show summary so user knows which ID to pick
|
||||
print("\n--- Select Pen to Edit ---")
|
||||
self.show_summary_list()
|
||||
|
||||
try:
|
||||
idx = int(input("\nEnter the ID of the pen to edit: "))
|
||||
pen = self.pens[idx]
|
||||
except (ValueError, IndexError):
|
||||
print("[!] Invalid ID.")
|
||||
return
|
||||
|
||||
print("\n--- Editing Pen Details ---")
|
||||
print("(Press ENTER without typing to keep the current value)\n")
|
||||
|
||||
# We iterate through headers so we don't miss any column
|
||||
for header in self.headers:
|
||||
field = self.key_map.get(header, header)
|
||||
current_val = getattr(pen, field)
|
||||
while True:
|
||||
new_val = input(f"{header} [{current_val}]: ").strip()
|
||||
if not new_val:
|
||||
break
|
||||
if header in ['Date-Purchased', 'Inked-date']:
|
||||
if validate_date(new_val):
|
||||
break
|
||||
else:
|
||||
print("Invalid date format. Use YYYY-MM-DD.")
|
||||
else:
|
||||
break
|
||||
if new_val: # If the user actually typed something new
|
||||
setattr(pen, field, new_val)
|
||||
|
||||
self.save_data()
|
||||
print("\n[✔] Pen updated successfully!")
|
||||
|
||||
def show_summary_list(self):
|
||||
"""Helper to print a list without the interactive menu logic."""
|
||||
print(f"{'ID':<4} | {'MAKE':<12} | {'MODEL':<12} | {'INK':<15}")
|
||||
print("-" * 55)
|
||||
for idx, pen in enumerate(self.pens):
|
||||
make = pen.Make[:12]
|
||||
model = pen.Model[:12]
|
||||
ink = pen.Current_Ink[:15]
|
||||
print(f"{idx:<4} | {make:<12} | {model:<12} | {ink:<15}")
|
||||
|
||||
def view_all_pens(self):
|
||||
if not self.pens:
|
||||
print("\n[!] Your collection is currently empty.")
|
||||
return
|
||||
|
||||
print("\n" + "="*85)
|
||||
print(f"{'ID':<4} | {'MAKE':<12} | {'MODEL':<12} | {'INK':<15} | {'INKED DATE':<12}")
|
||||
print("-" * 85)
|
||||
|
||||
for idx, pen in enumerate(self.pens):
|
||||
make = pen.Make[:12]
|
||||
model = pen.Model[:12]
|
||||
ink = pen.Current_Ink[:15]
|
||||
inkdate = pen.Inked_date[:12]
|
||||
print(f"{idx:<4} | {make:<12} | {model:<12} | {ink:<15} | {inkdate:<12}")
|
||||
|
||||
print("="*85)
|
||||
|
||||
choice = input("\nEnter ID to see full details (or 'b' to go back): ")
|
||||
if choice.lower() != 'b':
|
||||
try:
|
||||
self.view_pen_details(int(choice))
|
||||
except (ValueError, IndexError):
|
||||
print("[!] Invalid ID.")
|
||||
|
||||
def view_pen_details(self, index):
|
||||
pen = self.pens[index]
|
||||
print("\n" + "═"*45)
|
||||
print(f"{' FOUNTAIN PEN DETAILS ':=^45}")
|
||||
for header in self.headers:
|
||||
field = self.key_map.get(header, header)
|
||||
value = getattr(pen, field)
|
||||
print(f"{header:<20}: {value}")
|
||||
print("═"*45)
|
||||
input("\nPress Enter to return to menu...")
|
||||
|
||||
def delete_pen(self):
|
||||
if not self.pens:
|
||||
print("\n[!] Nothing to delete.")
|
||||
return
|
||||
self.show_summary_list()
|
||||
try:
|
||||
idx = int(input("\nEnter the ID of the pen to delete: "))
|
||||
removed = self.pens.pop(idx)
|
||||
self.save_data()
|
||||
print(f"\n[!] Removed: {removed.Make} {removed.Model}")
|
||||
except (ValueError, IndexError):
|
||||
print("[!] Invalid ID.")
|
||||
|
||||
def clear_screen():
|
||||
os.system('cls' if os.name == 'nt' else 'clear')
|
||||
|
||||
def main():
|
||||
# This is the entry point defined in pyproject.toml
|
||||
parser = argparse.ArgumentParser(description="Fountain Pen Tracker")
|
||||
parser.add_argument('--csv', default=None, help='Path to CSV file')
|
||||
subparsers = parser.add_subparsers(dest='command', help='Commands')
|
||||
|
||||
# Add command
|
||||
add_parser = subparsers.add_parser('add', help='Add a new pen')
|
||||
add_parser.add_argument('--make', required=True)
|
||||
add_parser.add_argument('--model', required=True)
|
||||
add_parser.add_argument('--date-purchased')
|
||||
add_parser.add_argument('--vendor')
|
||||
add_parser.add_argument('--nib')
|
||||
add_parser.add_argument('--nib-material')
|
||||
add_parser.add_argument('--body')
|
||||
add_parser.add_argument('--cap')
|
||||
add_parser.add_argument('--post')
|
||||
add_parser.add_argument('--current-ink')
|
||||
add_parser.add_argument('--inked-date')
|
||||
add_parser.add_argument('--notes')
|
||||
|
||||
# List command
|
||||
list_parser = subparsers.add_parser('list', help='List all pens')
|
||||
|
||||
# Export command
|
||||
export_parser = subparsers.add_parser('export', help='Export to JSON')
|
||||
export_parser.add_argument('--output', default='pens.json', help='Output file')
|
||||
|
||||
args = parser.parse_args()
|
||||
|
||||
tracker = CLITracker(args.csv)
|
||||
|
||||
if args.command == 'add':
|
||||
# Validate dates
|
||||
if args.date_purchased and not validate_date(args.date_purchased):
|
||||
print("Invalid date-purchased format.")
|
||||
return
|
||||
if args.inked_date and not validate_date(args.inked_date):
|
||||
print("Invalid inked-date format.")
|
||||
return
|
||||
pen_data = {
|
||||
'Make': args.make,
|
||||
'Model': args.model,
|
||||
'Date-Purchased': args.date_purchased or 'N/A',
|
||||
'Vendor': args.vendor or 'N/A',
|
||||
'Nib': args.nib or 'N/A',
|
||||
'Nib-Material': args.nib_material or 'N/A',
|
||||
'Body': args.body or 'N/A',
|
||||
'Cap': args.cap or 'N/A',
|
||||
'Post': args.post or 'N/A',
|
||||
'Current-Ink': args.current_ink or 'N/A',
|
||||
'Inked-date': args.inked_date or 'N/A',
|
||||
'Notes': args.notes or 'N/A'
|
||||
}
|
||||
mapped_data = {tracker.key_map.get(k, k): v for k, v in pen_data.items()}
|
||||
new_pen = Pen(**mapped_data)
|
||||
tracker.pens.append(new_pen)
|
||||
tracker.save_data()
|
||||
print("Pen added successfully.")
|
||||
elif args.command == 'list':
|
||||
tracker.view_all_pens()
|
||||
elif args.command == 'export':
|
||||
with open(args.output, 'w') as f:
|
||||
json.dump([asdict(p) for p in tracker.pens], f, indent=2)
|
||||
print(f"Exported to {args.output}")
|
||||
else:
|
||||
# Interactive mode
|
||||
while True:
|
||||
print("\n🖋️ FOUNTAIN PEN TRACKER (CSV Edition)")
|
||||
print("1. View Collection Summary")
|
||||
print("2. Add New Pen")
|
||||
print("3. Edit a Pen")
|
||||
print("4. Delete a Pen")
|
||||
print("5. Exit")
|
||||
|
||||
choice = input("\nSelect an option: ")
|
||||
|
||||
if choice == '1':
|
||||
clear_screen()
|
||||
tracker.view_all_pens()
|
||||
elif choice == '2':
|
||||
clear_screen()
|
||||
tracker.add_pen()
|
||||
elif choice == '3':
|
||||
clear_screen()
|
||||
tracker.edit_pen()
|
||||
elif choice == '4':
|
||||
clear_screen()
|
||||
tracker.delete_pen()
|
||||
elif choice == '5':
|
||||
print("Goodbye! Happy writing! ✒️")
|
||||
break
|
||||
else:
|
||||
print("[!] Invalid selection. Please try again.")
|
||||
85
build/lib/pen_tracker/engine.py
Normal file
85
build/lib/pen_tracker/engine.py
Normal file
|
|
@ -0,0 +1,85 @@
|
|||
import csv
|
||||
import os
|
||||
import logging
|
||||
from dataclasses import dataclass, asdict
|
||||
from typing import List
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
@dataclass
|
||||
class Pen:
|
||||
Make: str = "N/A"
|
||||
Model: str = "N/A"
|
||||
Date_Purchased: str = "N/A"
|
||||
Vendor: str = "N/A"
|
||||
Nib: str = "N/A"
|
||||
Nib_Material: str = "N/A"
|
||||
Body: str = "N/A"
|
||||
Cap: str = "N/A"
|
||||
Post: str = "N/A"
|
||||
Current_Ink: str = "N/A"
|
||||
Inked_date: str = "N/A"
|
||||
Notes: str = "N/A"
|
||||
|
||||
class PenTracker:
|
||||
def __init__(self, storage_file: str = None):
|
||||
if storage_file is None:
|
||||
storage_file = os.getenv('PEN_TRACKER_CSV', 'Pens.csv')
|
||||
self.storage_file = storage_file
|
||||
self.headers = [
|
||||
'Make', 'Model', 'Date-Purchased', 'Vendor', 'Nib',
|
||||
'Nib-Material', 'Body', 'Cap', 'Post',
|
||||
'Current-Ink', 'Inked-date', 'Notes'
|
||||
]
|
||||
self.key_map = {
|
||||
'Date-Purchased': 'Date_Purchased',
|
||||
'Inked-date': 'Inked_date',
|
||||
'Nib-Material': 'Nib_Material',
|
||||
'Current-Ink': 'Current_Ink'
|
||||
}
|
||||
self.reverse_key_map = {v: k for k, v in self.key_map.items()}
|
||||
self.pens: List[Pen] = self.load_data()
|
||||
|
||||
def _sort_pens(self):
|
||||
"""Sorts the pens list by Make, then by Model alphabetically."""
|
||||
self.pens.sort(key=lambda x: (x.Make.lower(), x.Model.lower()))
|
||||
|
||||
def load_data(self) -> List[Pen]:
|
||||
"""Loads data from the CSV file."""
|
||||
if not os.path.exists(self.storage_file):
|
||||
self._create_empty_csv()
|
||||
return []
|
||||
|
||||
pens = []
|
||||
try:
|
||||
# Standard, clean way to open the file
|
||||
with open(self.storage_file, mode='r', encoding='utf-8-sig') as f:
|
||||
reader = csv.DictReader(f)
|
||||
for row in reader:
|
||||
# Strip whitespace from keys and values, handle empty values
|
||||
clean_row = {k.strip(): (v.strip() if v else "N/A") for k, v in row.items()}
|
||||
# Map keys to dataclass field names
|
||||
mapped_row = {self.key_map.get(k, k): v for k, v in clean_row.items()}
|
||||
pens.append(Pen(**mapped_row))
|
||||
pens.sort(key=lambda x: (x.Make.lower(), x.Model.lower()))
|
||||
except Exception as e:
|
||||
logger.error(f"Error loading CSV: {e}")
|
||||
return pens
|
||||
|
||||
def _create_empty_csv(self):
|
||||
"""Creates the CSV file with headers if it is missing."""
|
||||
with open(self.storage_file, mode='w', newline='', encoding='utf-8') as f:
|
||||
writer = csv.DictWriter(f, fieldnames=self.headers)
|
||||
writer.writeheader()
|
||||
|
||||
def save_data(self):
|
||||
"""Sorts the data before writing to ensure persistent alphabetical order."""
|
||||
self._sort_pens()
|
||||
with open(self.storage_file, mode='w', newline='', encoding='utf-8') as f:
|
||||
writer = csv.DictWriter(f, fieldnames=self.headers)
|
||||
writer.writeheader()
|
||||
for pen in self.pens:
|
||||
row = asdict(pen)
|
||||
# Map back to CSV keys
|
||||
csv_row = {k.replace('_', '-'): v for k, v in row.items()}
|
||||
writer.writerow(csv_row)
|
||||
159
build/lib/pen_tracker/tui.py
Normal file
159
build/lib/pen_tracker/tui.py
Normal file
|
|
@ -0,0 +1,159 @@
|
|||
from textual.app import App, ComposeResult
|
||||
from textual.screen import Screen
|
||||
from textual.widgets import Label, Input, Button, Header, Footer, DataTable
|
||||
from textual.containers import Vertical, Horizontal
|
||||
from textual.binding import Binding
|
||||
from .engine import PenTracker, Pen
|
||||
# --- TUI SCREENS ---
|
||||
|
||||
class PenFormScreen(Screen):
|
||||
"""A screen for adding or editing a pen."""
|
||||
|
||||
def __init__(self, tracker, existing_pen=None):
|
||||
super().__init__()
|
||||
self.tracker = tracker
|
||||
self.existing_pen = existing_pen
|
||||
|
||||
def compose(self) -> ComposeResult:
|
||||
with Vertical(id="form-container"):
|
||||
yield Label("📝 NEW PEN" if not self.existing_pen else "✏️ EDIT PEN")
|
||||
|
||||
for header in self.tracker.headers:
|
||||
field = self.tracker.key_map.get(header, header)
|
||||
val = getattr(self.existing_pen, field) if self.existing_pen else ""
|
||||
yield Input(value=val, placeholder=header, id=header)
|
||||
|
||||
with Horizontal():
|
||||
yield Button("Save", variant="success", id="save_cmd")
|
||||
yield Button("Cancel", variant="error", id="cancel_cmd")
|
||||
|
||||
def on_button_pressed(self, event: Button.Pressed) -> None:
|
||||
if event.button.id == "cancel_cmd":
|
||||
self.dismiss()
|
||||
return
|
||||
|
||||
new_data = {}
|
||||
for header in self.tracker.headers:
|
||||
try:
|
||||
input_widget = self.query_one(f"#{header}", Input)
|
||||
new_data[header] = input_widget.value if input_widget.value.strip() else "N/A"
|
||||
except Exception:
|
||||
new_data[header] = "N/A"
|
||||
|
||||
# Map to Pen fields
|
||||
mapped_data = {self.tracker.key_map.get(k, k): v for k, v in new_data.items()}
|
||||
new_pen = Pen(**mapped_data)
|
||||
|
||||
if self.existing_pen is not None and self.existing_pen in self.tracker.pens:
|
||||
idx = self.tracker.pens.index(self.existing_pen)
|
||||
self.tracker.pens[idx] = new_pen
|
||||
else:
|
||||
self.tracker.pens.append(new_pen)
|
||||
|
||||
# save_data() handles the sorting internally
|
||||
self.tracker.save_data()
|
||||
self.dismiss(new_pen)
|
||||
|
||||
class PenTrackerApp(App):
|
||||
"""The Main TUI Application."""
|
||||
|
||||
CSS = """
|
||||
#form-container {
|
||||
width: 60%;
|
||||
height: auto;
|
||||
border: heavy white;
|
||||
padding: 1 2;
|
||||
margin: 5 10;
|
||||
background: $panel;
|
||||
}
|
||||
Label {
|
||||
width: 100%;
|
||||
text-align: center;
|
||||
text-style: bold;
|
||||
margin-bottom: 1;
|
||||
}
|
||||
Input {
|
||||
margin-bottom: 1;
|
||||
}
|
||||
Horizontal {
|
||||
align: center middle;
|
||||
height: auto;
|
||||
}
|
||||
Button {
|
||||
margin: 0 1;
|
||||
}
|
||||
DataTable {
|
||||
height: 1fr;
|
||||
}
|
||||
"""
|
||||
|
||||
BINDINGS = [
|
||||
Binding("d", "delete_selected", "Delete Selected"),
|
||||
Binding("a", "add_new", "Add New Pen"),
|
||||
Binding("q", "quit", "Quit"),
|
||||
]
|
||||
|
||||
def compose(self) -> ComposeResult:
|
||||
yield Header()
|
||||
yield DataTable(id="pen_table")
|
||||
yield Footer()
|
||||
|
||||
def on_mount(self) -> None:
|
||||
self.tracker = PenTracker('Pens.csv')
|
||||
self._refresh_table()
|
||||
|
||||
def _refresh_table(self):
|
||||
table = self.query_one("#pen_table", DataTable)
|
||||
table.clear(columns=True)
|
||||
|
||||
display_cols = ['Make', 'Model', 'Nib', 'Nib-Material', 'Body','Cap', 'Current-Ink', 'Inked-date', 'Notes']
|
||||
table.add_columns(*display_cols)
|
||||
|
||||
for idx, pen in enumerate(self.tracker.pens):
|
||||
row_values = [getattr(pen, c.replace('-','_')) for c in display_cols]
|
||||
# We use the index as the row key to track items accurately
|
||||
table.add_row(*row_values, key=str(idx))
|
||||
|
||||
def action_add_new(self) -> None:
|
||||
form = PenFormScreen(self.tracker)
|
||||
self.push_screen(form, self.handle_form_result)
|
||||
|
||||
def action_edit_selected(self, index_str: str):
|
||||
try:
|
||||
idx = int(index_str)
|
||||
existing_pen = self.tracker.pens[idx]
|
||||
form = PenFormScreen(self.tracker, existing_pen=existing_pen)
|
||||
self.push_screen(form, self.handle_form_result)
|
||||
except (ValueError, IndexError):
|
||||
pass
|
||||
|
||||
def handle_form_result(self, updated_pen_data) -> None:
|
||||
if updated_pen_data:
|
||||
self._refresh_table()
|
||||
self.notify("Collection Updated & Sorted!", title="Success")
|
||||
|
||||
def action_delete_selected(self) -> None:
|
||||
table = self.query_one("#pen_table", DataTable)
|
||||
try:
|
||||
# Accessing via the table's current cursor
|
||||
table = self.query_one("#pen_table", DataTable)
|
||||
row_node = table.get_row_at_cursor()
|
||||
idx = int(row_node.key.value)
|
||||
removed = self.tracker.pens.pop(idx)
|
||||
self.tracker.save_data()
|
||||
self._refresh_table()
|
||||
self.notify(f"Deleted {removed.Make}", title="Removed")
|
||||
except Exception:
|
||||
self.notify("No pen selected to delete", title="Error", severity="error")
|
||||
|
||||
def on_data_table_cell_selected(self, event: DataTable.CellSelected) -> None:
|
||||
try:
|
||||
idx = int(event.cell_key.row_key.value)
|
||||
self.action_edit_selected(str(idx))
|
||||
except (AttributeError, ValueError):
|
||||
self.notify("Error selecting row", title="Error", severity="error")
|
||||
|
||||
def main():
|
||||
# This is the entry point defined in pyproject.toml
|
||||
app = PenTrackerApp()
|
||||
app.run()
|
||||
Loading…
Add table
Add a link
Reference in a new issue