improve-cli 0.1.0__py3-none-any.whl

improve.py

@@ -0,0 +1,129 @@
+"""Improve CLI"""
+"""Developed by: harshit-malik25813"""
+"""Open Sourced on GitHub"""
+"""https://github.com/harshit-malik25813/Improve"""
+import argparse # To include the functionality of parsing the arguements
+import json # To Read JSON file containing the user data
+from pathlib import Path # To locate the path of essential tracking data
+# Essential helper functions imported
+from src import helpers, setup as setup_mod, project as project_mod 
+from src.help import show_help, commands 
+
+# User tracking path
+USER_FILE = Path("tracking") / "user_info.json"
+
+# Internal function to load user data and return it
+def _load_user():
+	if USER_FILE.exists():
+		with USER_FILE.open("r", encoding="utf-8") as f:
+			return json.load(f)
+	return {"user_exists": False, "user_name": "", "password": ""}
+
+# Main program
+def main():
+	# Adding argument parsers
+	parser = argparse.ArgumentParser(prog="improve", description="Improve CLI") # Initiate parsing of arguements
+	# Allow subparsers in the program
+	subparsers = parser.add_subparsers(dest="command")
+
+	# setup arguments
+	setup_parser = subparsers.add_parser("setup", help="Manage your local user account")
+	setup_sub = setup_parser.add_subparsers(dest="setup_cmd", required=True)
+	setup_sub.add_parser("login", help="Create or sign in to your local account")
+	setup_sub.add_parser("logout", help="Sign out and clear local user data")
+	update_parser = setup_sub.add_parser("update", help="Update username or password")
+	update_group = update_parser.add_mutually_exclusive_group(required=True)
+	update_group.add_argument("--username", action="store_true", help="Change username")
+	update_group.add_argument("--password", action="store_true", help="Change password")
+
+	# help (use "help" not "--help"; argparse reserves --help for usage)
+	help_parser = subparsers.add_parser("help", help="Show help or list commands")
+	help_parser.add_argument("--commands", action="store_true", help="List all commands")
+
+	# add-project (legacy) - kept for backward compatibility as the feature has been integrated with project command
+	addp = subparsers.add_parser("add-project") # add-project argument
+	addp.add_argument("project_name") # Project name
+
+	# project management group(improved)
+	project_parser = subparsers.add_parser("project")
+	project_sub = project_parser.add_subparsers(dest="proj_cmd")
+	project_sub.add_parser("list")
+	create = project_sub.add_parser("create")
+	create.add_argument("project_name")
+	add_entry = project_sub.add_parser("add-entry")
+	add_entry.add_argument("project_name")
+	add_entry.add_argument("--day", default="")
+	add_entry.add_argument("--date", default="")
+	add_entry.add_argument("--progress", default="")
+	add_entry.add_argument("--productivity", default="")
+	add_entry.add_argument("--feedback", default="")
+	feedback = project_sub.add_parser("feedback")
+	feedback.add_argument("project_name")
+	feedback.add_argument("--last", type=int, default=5)
+	show = project_sub.add_parser("show")
+	show.add_argument("project_name")
+	show.add_argument("--last", type=int, default=10)
+	delete = project_sub.add_parser("delete")
+	delete.add_argument("project_name")
+
+	# export
+	subparsers.add_parser("export")
+
+	args = parser.parse_args()
+
+	user_info = _load_user() # Load user data
+	if not user_info.get("user_exists"): # If the user data doesn't exist
+		helpers.first_time() # Initiate the script to invite user for the first time
+	else:
+		print(f"Welcome back!, {user_info.get('user_name')}")
+
+	if args.command == "setup":
+		if args.setup_cmd == "login":
+			setup_mod.login()
+		elif args.setup_cmd == "logout":
+			setup_mod.logout()
+		elif args.setup_cmd == "update":
+			if args.username:
+				setup_mod.update_user("username")
+			else:
+				setup_mod.update_user("password")
+		return
+
+	if args.command == "help":
+		if args.commands:
+			commands()
+		else:
+			show_help()
+		return
+
+	if args.command == "add-project": # Legacy function to create the project
+		# legacy behavior: create project CSV
+		project_mod.create_project(args.project_name) # Use the create project function in place of add_project.py
+		return
+	# Project functions
+	if args.command == "project":
+		if args.proj_cmd == "list":
+			project_mod.list_projects()
+		elif args.proj_cmd == "create":
+			project_mod.create_project(args.project_name)
+		elif args.proj_cmd == "add-entry":
+			project_mod.add_entry(args.project_name, day=args.day, date=args.date, progress=args.progress, productivity=args.productivity, feedback=args.feedback)
+		elif args.proj_cmd == "feedback":
+			project_mod.get_feedback(args.project_name, last=args.last)
+		elif args.proj_cmd == "show":
+			project_mod.show_project(args.project_name, last=args.last)
+		elif args.proj_cmd == "delete":
+			project_mod.delete_project(args.project_name)
+		else:
+			show_help()
+		return
+	# Export functions
+	if args.command == "export":
+		from src.export import export_data
+		export_data()
+		return
+	# if invalid
+	parser.print_help()
+# Initialise the function
+if __name__ == "__main__":
+	main()

improve_cli-0.1.0.dist-info/METADATA

@@ -0,0 +1,164 @@
+Metadata-Version: 2.4
+Name: improve-cli
+Version: 0.1.0
+Summary: CLI project tracker with CSV-backed logs
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# **Improve — CLI Project Tracker**
+
+Improve is a small, single-file CLI application (with supporting modules under `src/`) to help you track progress on projects using CSV-backed project logs. It provides simple user setup, per-project CSV tracking, quick reporting and export functionality.
+
+## **Features**
+- **User setup:** create, update, and logout a local user account (`setup` commands).
+- **Project management:** create, list, delete projects and add daily entries (`project` commands).
+- **Entry tracking:** each project is stored as a CSV under `tracking/` with columns Day, Date, Progress, Productivity Level, Feedback.
+- **Feedback & view:** fetch recent feedback entries or show recent rows for a project.
+- **Export:** copy all tracking CSV files to a `backup/` folder.
+
+### **Quick Links**
+- Main CLI entry: [improve.py](improve.py)
+- Core project logic: [src/project.py](src/project.py)
+- User/setup utilities: [src/setup.py](src/setup.py)
+- Export helper: [src/export.py](src/export.py)
+- First-run helper text: [src/helpers.py](src/helpers.py)
+- Legacy project helper: [src/add_project.py](src/add_project.py)
+
+## **Requirements**
+- Python 3.9+ (`requires-python` in [pyproject.toml](pyproject.toml); uses standard library features such as `dataclasses` and `pathlib`).
+- No third-party runtime dependencies. The package is defined in [pyproject.toml](pyproject.toml); [requirements.txt](requirements.txt) only lists standard-library modules for reference and is not used by pip.
+
+## **Install with pip**
+
+From a clone of this repository (recommended: use a virtual environment):
+
+```bash
+python3 -m venv .venv
+source .venv/bin/activate   # Windows: .venv\Scripts\activate
+pip install .
+```
+
+After install, the `improve` console script is on your `PATH` (same commands as `python improve.py` below).
+
+For local development (changes to `improve.py` or `src/` apply without reinstalling):
+
+```bash
+pip install -e .
+```
+
+Install a built wheel without cloning:
+
+```bash
+pip install dist/improve_cli-0.1.0-py3-none-any.whl
+```
+
+## **Build from source**
+
+Build sdist and wheel artifacts into `dist/` (requires [build](https://pypi.org/project/build/) once per environment):
+
+```bash
+python3 -m venv .venv
+source .venv/bin/activate
+pip install build
+python -m build
+```
+
+Outputs:
+- `dist/improve_cli-0.1.0.tar.gz` — source distribution
+- `dist/improve_cli-0.1.0-py3-none-any.whl` — installable wheel
+
+Install the wheel locally:
+
+```bash
+pip install dist/improve_cli-0.1.0-py3-none-any.whl
+```
+
+## **Run without installing**
+
+Clone the repo, create a venv if you like, and invoke the entry module directly:
+
+```bash
+python improve.py --help
+```
+
+## **Running the CLI**
+- Basic help:
+
+```bash
+improve --help
+# or: python improve.py --help
+```
+
+- Setup a user account (interactive):
+
+```bash
+improve setup login
+```
+
+- Sign out and clear local user data:
+
+```bash
+improve setup logout
+```
+
+- Update username or password:
+
+```bash
+improve setup update --username
+improve setup update --password
+```
+
+- Create a project:
+
+```bash
+improve project create MyProject
+```
+
+- Add an entry to a project:
+
+```bash
+improve project add-entry MyProject --day "Day 1" --date "2026-05-28" --progress "Started" --productivity "7" --feedback "Good start"
+```
+
+- List projects:
+
+```bash
+improve project list
+```
+
+- Show recent entries for a project:
+
+```bash
+improve project show MyProject --last 10
+```
+
+- Get recent feedback entries:
+
+```bash
+improve project feedback MyProject --last 5
+```
+
+- Export all tracking CSVs to `backup/`:
+
+```bash
+improve export
+```
+
+**Storage & File Layout**
+- Tracking CSVs and user info are stored in the `tracking/` directory. Example files:
+	- `tracking/MyProject.csv` — per-project CSV with header `Day,Date,Progress,Productivity Level,Feedback`
+	- `tracking/user_info.json` — stores a small JSON object with `user_exists`, `user_name`, and `password`.
+
+**Notes & Behavior**
+- The CLI is implemented in `improve.py` and delegates commands to modules in `src/`.
+- Password validation enforces a minimum length and requires digits, alphabetic, uppercase, lowercase and a special character (see `src/setup.py`).
+- The `add-project` command is retained for backward compatibility but `project create` is preferred.
+
+**Development & Contribution**
+- Use `pip install -e .` and run `improve`, or run `python improve.py` without installing.
+- Rebuild distributables with `python -m build` after packaging changes.
+- The codebase is small and intended as a learning/demo project. Contributions or issues can be opened against the original upstream repository referenced in the code comments.
+
+

improve_cli-0.1.0.dist-info/RECORD

@@ -0,0 +1,13 @@
+improve.py,sha256=URtBOBz0DZdxPUha_9X9KyOUSvjFSd8FRetnlx6unqk,4976
+improve_cli-0.1.0.dist-info/licenses/LICENSE,sha256=Gx6gQSILjb0n_mNNc0n_t9PepS9513UsjlMLRojgF3E,1075
+src/__init__.py,sha256=QQ453nXqN0jo3CcLjOviklQO-appJP-FCgo7Vm6wVp0,97
+src/export.py,sha256=Tc7ZcJLjC4PN0E1eVt3mZeCGYNf11DmdlFq4NAmgAGs,886
+src/help.py,sha256=gAzemecKifrDiNzm0TPCgWz9Xxr7Po48IE0nvlqm_Do,719
+src/helpers.py,sha256=kILSXx7-1qCYidiqhDvVMvslL3AgECavavLHqkD0rlI,523
+src/project.py,sha256=3KZBLPphUvvHjEWkKf7_HMRG0m9oFomb8H0xkKsm-3Y,3350
+src/setup.py,sha256=B_pg9njQsCouq9LUr01el1RjNJH33lPxuqst24p3v0c,5640
+improve_cli-0.1.0.dist-info/METADATA,sha256=HMcnNQgHD6sDPWkHqPbPG9oseYDkxoNwzbiHokiENQE,4836
+improve_cli-0.1.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+improve_cli-0.1.0.dist-info/entry_points.txt,sha256=szXk0Yhe_HCKwjlJtqiPask90N0uhGlDhs1DBmzZSXU,41
+improve_cli-0.1.0.dist-info/top_level.txt,sha256=1evx0noKIWBgNokQL2NSKjYonTD91I9OlfOYkJkc6x8,12
+improve_cli-0.1.0.dist-info/RECORD,,

improve_cli-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

improve_cli-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+improve = improve:main

improve_cli-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 harshit-malik25813
+
+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.

improve_cli-0.1.0.dist-info/top_level.txt

@@ -0,0 +1,2 @@
+improve
+src

src/__init__.py

@@ -0,0 +1 @@
+"""Initialising the directory to allow for importing functions from the files in the directory"""

src/export.py

@@ -0,0 +1,23 @@
+import shutil
+from pathlib import Path
+
+# To export user tracking data to a CSV file
+def export_data():
+    tracking_folder = Path("tracking") 
+    if not tracking_folder.exists(): # If user exports data but the folder doesnt contain any
+        print("No tracking data found.") 
+        return
+
+    csv_files = list(tracking_folder.glob("*.csv")) # Creating a list of files in the folder
+
+    destination_folder = Path("backup") # Creating a folder called backup to copy the tracked CSV files
+    destination_folder.mkdir(parents=True, exist_ok=True)
+
+    for csv_file in csv_files:
+        shutil.copy2(csv_file, destination_folder / csv_file.name)
+
+    print("Export was successful!")
+    print("Find your exported progress in CSV format in:\n" \
+          f"{destination_folder.resolve()}")
+    print("You can still continue with your progress as it hasnt been deleted")
+    return

src/help.py

@@ -0,0 +1,19 @@
+def show_help():
+    print("Improve")
+    print("You might have entered a wrong command to get here")
+    print("To see the list of commands, run: improve help --commands")
+
+
+def commands():
+    print("Available commands:")
+    print("  setup login")
+    print("  setup logout")
+    print("  setup update --username | --password")
+    print("  project list")
+    print("  project create <name>")
+    print("  project add-entry <name> [--day] [--date] [--progress] [--productivity] [--feedback]")
+    print("  project show <name> [--last N]")
+    print("  project feedback <name> [--last N]")
+    print("  project delete <name>")
+    print("  add-project <name>   (legacy; prefer project create)")
+    print("  export")

src/helpers.py

@@ -0,0 +1,8 @@
+def first_time(): # When user opens the program for the first time
+	print("Welcome to Improve!")
+	print("Improve is a CLI-tool designed to help people manage and organize their \n " \
+	"ongoing projects and track their progress in them")
+	print("This project has been developed and open-sourced by harshit-malik25813 on GitHub")
+	print("For all those nerds, find this project on https://github.com/harshit-malik25813/Improve")
+	print("To start, setup your account by running 'improve setup login' in your terminal")
+	return

src/project.py

@@ -0,0 +1,94 @@
+import csv
+from pathlib import Path
+from typing import List
+# Project functions, most important part of the program
+# Defining constants
+TRACKING = Path("tracking") 
+HEADER = ["Day", "Date", "Progress", "Productivity Level", "Feedback"]
+
+# Function to make the project file
+def _project_file(name: str) -> Path:
+    TRACKING.mkdir(parents=True, exist_ok=True)
+    return TRACKING / f"{name}.csv"
+# Function to list the projects the user has created thus far
+
+def list_projects() -> List[str]:
+    if not TRACKING.exists():
+        print("No projects found.")
+        return []
+    projects = [p.stem for p in TRACKING.glob("*.csv")]
+    if not projects:
+        print("No projects found.")
+        return []
+    print("Projects:")
+    for p in projects:
+        print(f" - {p}")
+    return projects
+# Function to create a project
+
+def create_project(name: str) -> Path:
+    # Path to project file
+    path = _project_file(name)
+    # If the user has already created a project with this name before
+    if path.exists():
+        print(f"Project '{name}' already exists at {path}")
+        return path
+    # Create the basic structure of the project in the
+    with path.open("w", newline="", encoding="utf-8") as f:
+        writer = csv.writer(f)
+        writer.writerow(HEADER)
+    print(f"Project '{name}' created at {path}")
+    return path
+# Function to add an entry to the project
+
+def add_entry(name: str, day: str = "", date: str = "", progress: str = "", productivity: str = "", feedback: str = ""):
+    path = _project_file(name)
+    if not path.exists():
+        print(f"Project '{name}' does not exist. Creating it now.")
+        create_project(name)
+    row = [day, date, progress, productivity, feedback]
+    with path.open("a", newline="", encoding="utf-8") as f:
+        writer = csv.writer(f)
+        writer.writerow(row)
+    print(f"Added entry to project '{name}'.")
+# Function to retrieve feedbacks
+
+def get_feedback(name: str, last: int = 5):
+    path = _project_file(name)
+    if not path.exists():
+        print(f"Project '{name}' not found.")
+        return
+    with path.open("r", encoding="utf-8") as f:
+        reader = list(csv.DictReader(f))
+    feedbacks = [r.get("Feedback", "") for r in reader if r.get("Feedback")]
+    if not feedbacks:
+        print("No feedback entries found.")
+        return
+    print(f"Last {last} feedback entries for '{name}':")
+    for fb in feedbacks[-last:]:
+        print(f" - {fb}")
+# Function to show the project progress as the user asks
+
+def show_project(name: str, last: int = 10):
+    path = _project_file(name)
+    if not path.exists():
+        print(f"Project '{name}' not found.")
+        return
+    with path.open("r", encoding="utf-8") as f:
+        reader = list(csv.DictReader(f))
+    if not reader:
+        print("No entries yet.")
+        return
+    rows = reader[-last:]
+    print(f"Showing last {len(rows)} entries for '{name}':")
+    for r in rows:
+        print(f"Day: {r.get('Day','')}, Date: {r.get('Date','')}, Progress: {r.get('Progress','')}, Productivity: {r.get('Productivity Level','')}, Feedback: {r.get('Feedback','')}")
+
+# Function to delete the project
+def delete_project(name: str):
+    path = _project_file(name)
+    if not path.exists():
+        print(f"Project '{name}' not found.")
+        return
+    path.unlink()
+    print(f"Project '{name}' deleted.")

src/setup.py

@@ -0,0 +1,152 @@
+"""User setup utilities for Improve CLI"""
+from dataclasses import dataclass # to create dataclass for user 
+import json # to access user data in JSON file
+from pathlib import Path # To manipulate the folder and files
+import shutil # To make directories
+from .export import export_data # Export data
+from .help import show_help # Printing help
+
+USER_FILE = Path("tracking") / "user_info.json" # The path of user file 
+# Declaring essential functions
+
+def _load_user_info():
+    # Do not create the file by default. Return defaults if file missing.
+    if not USER_FILE.exists():
+        return {"user_exists": False, "user_name": "", "password": ""}
+    with USER_FILE.open("r", encoding="utf-8") as f:
+        return json.load(f)
+
+# To write user_info
+def _write_user_info(data: dict):
+    # To write user info in a JSON file for the first time
+    USER_FILE.parent.mkdir(parents=True, exist_ok=True)
+    with USER_FILE.open("w", encoding="utf-8") as f:
+        json.dump(data, f, indent=2)
+
+# To validate password
+def _validate_password(pw: str) -> tuple[bool, str]:
+    if len(pw) < 8:
+        return False, "Password must be at least 8 characters"
+    if not any(c.isdigit() for c in pw):
+        return False, "Password must contain a digit"
+    special_char = "!@#$%^&*()"
+    if not any(c in special_char for c in pw):
+        return False, "Password must contain a special character"
+    if not any(c.isalpha() for c in pw):
+        return False, "Password must contain alphabetic characters"
+    if not any(c.islower() for c in pw):
+        return False, "Password must contain a lowercase character"
+    if not any(c.isupper() for c in pw):
+        return False, "Password must contain an uppercase character"
+    return True, ""
+
+# Logging user in
+def login():
+    data = _load_user_info()
+    # If user exists, no need to do anything
+    if data.get("user_exists"):
+        print(f"A user already exists. You are logged in as {data.get('user_name')}")
+        return
+
+    print("User Account not set")
+    # Get user confirmation
+    ans = input("Do you want to set a user? (y/n): ").strip().lower()
+    if ans not in ("y", "n"):
+        print("Invalid input. Please enter y or n.")
+        return
+    if ans == "n":
+        print("Aborting user setup")
+        return
+    # Setting up a dataclass to help with easily accessing username and password
+    @dataclass
+    class User:
+        user_name: str
+        password: str
+    # Setting up the user
+    # Only let user leave if he enters the username and password correctly
+    while True:
+        # Validating username and password
+        user_name = input("Username: ").strip()
+        if len(user_name) < 4:
+
+            print("The length of user name should be at least 4 characters!")
+            continue
+
+        password = input("Password: ")
+        valid, msg = _validate_password(password)
+        if not valid:
+            print(msg)
+            continue
+        user = User(user_name, password)
+        break
+
+    new_data = {"user_exists": True, "user_name": user.user_name, "password": user.password}
+    _write_user_info(new_data)
+    print("User has been set successfully!")
+    print("Log in to start your improvement journey!")
+
+# Logging user out
+def logout():
+    data = _load_user_info()
+    # If user tries to log out but user doesn't exist
+    if not data.get("user_exists"):
+        print("No user is currently logged in.")
+        return
+    print("Logout")
+    # Asking user for confirmation
+    confirmation = input("Are you sure you want to logout? Your data will be deleted unless exported (y/n): ").strip().lower()
+    if confirmation not in ("y", "n"):
+        print("Please respond with y or n")
+        return
+    if confirmation == "n":
+        return
+    # Ask user if he wishes to export his data
+    ans = input("Do you wish to export your progress report to CSV before logout? (y/n): ").strip().lower()
+    if ans == "y":
+        export_data()
+        # After successful export, offer to delete the tracking directory
+        try:
+            tracking_dir = USER_FILE.parent
+            if tracking_dir.exists():
+                delete_confirm = input("Export complete. Do you want to delete the tracking directory? (y/n): ").strip().lower()
+                if delete_confirm == "y":
+                    shutil.rmtree(tracking_dir)
+                    print("Tracking directory deleted.")
+        except Exception as e:
+            print(f"Warning: failed to delete tracking directory: {e}")
+    # Update JSON file
+    no_user = {"user_exists": False, "user_name": "", "password": ""}
+    _write_user_info(no_user)
+    print("Logged out and user data cleared.")
+
+# To update user data
+def update_user(field: str):
+    if field not in ("username", "password"):
+        print("Invalid input!")
+        show_help()
+        return
+    data = _load_user_info()
+    if not data.get("user_exists"):
+        print("No user set. Run 'improve setup login' to create an account.")
+        return
+
+    if field == "username":
+        new_username = input("Enter new username: ").strip()
+        if len(new_username) < 4:
+            print("Username must be at least 4 characters long")
+            return
+        data["user_name"] = new_username
+        _write_user_info(data)
+        print("Username updated.")
+        return
+
+    if field == "password":
+        new_password = input("Enter new password: ")
+        valid, msg = _validate_password(new_password)
+        if not valid:
+            print(msg)
+            return
+        data["password"] = new_password
+        _write_user_info(data)
+        print("Password updated.")
+        return