habit-tracker-cli 0.1.0__tar.gz

habit_tracker_cli-0.1.0/LICENSE

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

habit_tracker_cli-0.1.0/PKG-INFO

@@ -0,0 +1,201 @@
+Metadata-Version: 2.4
+Name: habit-tracker-cli
+Version: 0.1.0
+Summary: A small cross-platform habit tracker CLI with a polished interactive shell.
+Author: Luis696969
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/Luis696969/habit-tracker-cli
+Project-URL: Repository, https://github.com/Luis696969/habit-tracker-cli
+Project-URL: Issues, https://github.com/Luis696969/habit-tracker-cli/issues
+Project-URL: Changelog, https://github.com/Luis696969/habit-tracker-cli/blob/main/CHANGELOG.md
+Keywords: cli,habits,productivity,sqlite,typer,rich
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Utilities
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: platformdirs<5.0,>=4.0
+Requires-Dist: prompt_toolkit<4.0,>=3.0
+Requires-Dist: rich<14.0,>=13.7
+Requires-Dist: typer<1.0,>=0.12
+Provides-Extra: dev
+Requires-Dist: build<2.0,>=1.2; extra == "dev"
+Requires-Dist: pytest<9.0,>=8.0; extra == "dev"
+Requires-Dist: twine<6.0,>=5.0; extra == "dev"
+Dynamic: license-file
+
+# habit_tracker_cli
+
+`habit_tracker_cli` is a small cross-platform habit tracker for the terminal. It keeps the command-line workflow simple, stores data locally in SQLite, and includes a lightweight interactive shell for day-to-day use.
+
+Public command:
+
+```bash
+habit-tracker
+```
+
+## Features
+
+- Add daily habits or habits scheduled on specific weekdays
+- Mark habits as done for today
+- Show habits due today
+- Check the current streak for one habit
+- Show a weekly report
+- Use an interactive shell with help, manual pages, and tab completion
+- Clear local app data safely with `clear-data`
+
+## Installation
+
+### Windows
+
+Recommended: `pipx` from PowerShell or Windows Terminal. `pipx` keeps the app isolated and avoids cluttering the main Python environment.
+
+Install from source today:
+
+```powershell
+pipx install .
+```
+
+Future PyPI install target:
+
+```powershell
+pipx install habit-tracker-cli
+```
+
+### Linux
+
+Recommended: `pipx`.
+
+Install from source today:
+
+```bash
+pipx install .
+```
+
+Future PyPI install target:
+
+```bash
+pipx install habit-tracker-cli
+```
+
+### Development install from source
+
+```bash
+pip install -e .[dev]
+python -m pytest
+```
+
+## Usage
+
+```bash
+habit-tracker add "Read 20 min" --daily
+habit-tracker add "Go to the gym" --days mon,wed,fri
+habit-tracker list
+habit-tracker today
+habit-tracker done "Read 20 min"
+habit-tracker streak "Read 20 min"
+habit-tracker report
+habit-tracker report --week
+```
+
+`report` and `report --week` are equivalent in the current version.
+
+## Interactive shell
+
+Start it explicitly:
+
+```bash
+habit-tracker shell
+```
+
+Running `habit-tracker` with no subcommand also enters the shell.
+
+Prompt:
+
+```text
+habit>
+```
+
+Shell commands:
+
+- `add`
+- `list`
+- `today`
+- `done`
+- `streak`
+- `report`
+- `help`
+- `man`
+- `clear`
+- `clear-data`
+- `exit`
+- `q`
+
+## Data storage
+
+The app uses `platformdirs` for predictable per-user storage.
+
+Typical locations:
+
+| OS | Data location |
+| --- | --- |
+| Windows | `%LOCALAPPDATA%\habit_tracker_cli\` |
+| Linux | `$XDG_DATA_HOME/habit_tracker_cli/` or `~/.local/share/habit_tracker_cli/` |
+
+Shell state and history live in the matching per-user state/config directories for the same app name.
+
+Optional overrides:
+
+```bash
+HABIT_TRACKER_DB_PATH=/custom/path/habit_tracker.db
+HABIT_TRACKER_HOME=/custom/app-home
+```
+
+## Clear app data
+
+```bash
+habit-tracker clear-data
+habit-tracker clear-data --yes
+```
+
+`clear-data` shows the exact paths it plans to remove and asks for confirmation unless `--yes` is used.
+
+## Uninstall
+
+If you installed with `pipx`:
+
+```bash
+pipx uninstall habit-tracker-cli
+```
+
+If you installed from source in editable mode:
+
+```bash
+pip uninstall habit_tracker_cli
+```
+
+There is intentionally no built-in self-uninstall command. Uninstall remains a manual step for safety.
+
+## GitHub and PyPI readiness
+
+The repository is set up for GitHub publication now and for straightforward future PyPI publication later.
+
+Suggested future release flow:
+
+```bash
+python -m build
+python -m twine check dist/*
+```
+
+When PyPI trusted publishing is configured, releases can be connected to an upload workflow. Until then, manual publishing is the safest option.
+
+## License
+
+MIT

habit_tracker_cli-0.1.0/README.md

@@ -0,0 +1,168 @@
+# habit_tracker_cli
+
+`habit_tracker_cli` is a small cross-platform habit tracker for the terminal. It keeps the command-line workflow simple, stores data locally in SQLite, and includes a lightweight interactive shell for day-to-day use.
+
+Public command:
+
+```bash
+habit-tracker
+```
+
+## Features
+
+- Add daily habits or habits scheduled on specific weekdays
+- Mark habits as done for today
+- Show habits due today
+- Check the current streak for one habit
+- Show a weekly report
+- Use an interactive shell with help, manual pages, and tab completion
+- Clear local app data safely with `clear-data`
+
+## Installation
+
+### Windows
+
+Recommended: `pipx` from PowerShell or Windows Terminal. `pipx` keeps the app isolated and avoids cluttering the main Python environment.
+
+Install from source today:
+
+```powershell
+pipx install .
+```
+
+Future PyPI install target:
+
+```powershell
+pipx install habit-tracker-cli
+```
+
+### Linux
+
+Recommended: `pipx`.
+
+Install from source today:
+
+```bash
+pipx install .
+```
+
+Future PyPI install target:
+
+```bash
+pipx install habit-tracker-cli
+```
+
+### Development install from source
+
+```bash
+pip install -e .[dev]
+python -m pytest
+```
+
+## Usage
+
+```bash
+habit-tracker add "Read 20 min" --daily
+habit-tracker add "Go to the gym" --days mon,wed,fri
+habit-tracker list
+habit-tracker today
+habit-tracker done "Read 20 min"
+habit-tracker streak "Read 20 min"
+habit-tracker report
+habit-tracker report --week
+```
+
+`report` and `report --week` are equivalent in the current version.
+
+## Interactive shell
+
+Start it explicitly:
+
+```bash
+habit-tracker shell
+```
+
+Running `habit-tracker` with no subcommand also enters the shell.
+
+Prompt:
+
+```text
+habit>
+```
+
+Shell commands:
+
+- `add`
+- `list`
+- `today`
+- `done`
+- `streak`
+- `report`
+- `help`
+- `man`
+- `clear`
+- `clear-data`
+- `exit`
+- `q`
+
+## Data storage
+
+The app uses `platformdirs` for predictable per-user storage.
+
+Typical locations:
+
+| OS | Data location |
+| --- | --- |
+| Windows | `%LOCALAPPDATA%\habit_tracker_cli\` |
+| Linux | `$XDG_DATA_HOME/habit_tracker_cli/` or `~/.local/share/habit_tracker_cli/` |
+
+Shell state and history live in the matching per-user state/config directories for the same app name.
+
+Optional overrides:
+
+```bash
+HABIT_TRACKER_DB_PATH=/custom/path/habit_tracker.db
+HABIT_TRACKER_HOME=/custom/app-home
+```
+
+## Clear app data
+
+```bash
+habit-tracker clear-data
+habit-tracker clear-data --yes
+```
+
+`clear-data` shows the exact paths it plans to remove and asks for confirmation unless `--yes` is used.
+
+## Uninstall
+
+If you installed with `pipx`:
+
+```bash
+pipx uninstall habit-tracker-cli
+```
+
+If you installed from source in editable mode:
+
+```bash
+pip uninstall habit_tracker_cli
+```
+
+There is intentionally no built-in self-uninstall command. Uninstall remains a manual step for safety.
+
+## GitHub and PyPI readiness
+
+The repository is set up for GitHub publication now and for straightforward future PyPI publication later.
+
+Suggested future release flow:
+
+```bash
+python -m build
+python -m twine check dist/*
+```
+
+When PyPI trusted publishing is configured, releases can be connected to an upload workflow. Until then, manual publishing is the safest option.
+
+## License
+
+MIT

habit_tracker_cli-0.1.0/pyproject.toml

@@ -0,0 +1,59 @@
+[build-system]
+requires = ["setuptools>=69", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "habit-tracker-cli"
+version = "0.1.0"
+description = "A small cross-platform habit tracker CLI with a polished interactive shell."
+readme = "README.md"
+requires-python = ">=3.12"
+license = "MIT"
+authors = [
+  { name = "Luis696969" }
+]
+keywords = ["cli", "habits", "productivity", "sqlite", "typer", "rich"]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Environment :: Console",
+  "Intended Audience :: End Users/Desktop",
+  "Operating System :: Microsoft :: Windows",
+  "Operating System :: POSIX :: Linux",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Topic :: Utilities",
+]
+
+dependencies = [
+  "platformdirs>=4.0,<5.0",
+  "prompt_toolkit>=3.0,<4.0",
+  "rich>=13.7,<14.0",
+  "typer>=0.12,<1.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/Luis696969/habit-tracker-cli"
+Repository = "https://github.com/Luis696969/habit-tracker-cli"
+Issues = "https://github.com/Luis696969/habit-tracker-cli/issues"
+Changelog = "https://github.com/Luis696969/habit-tracker-cli/blob/main/CHANGELOG.md"
+
+[project.optional-dependencies]
+dev = [
+  "build>=1.2,<2.0",
+  "pytest>=8.0,<9.0",
+  "twine>=5.0,<6.0",
+]
+
+[project.scripts]
+habit-tracker = "habit_tracker_cli.cli:main"
+
+[tool.setuptools]
+package-dir = { "" = "src" }
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+addopts = "-q -p no:cacheprovider"
+testpaths = ["tests"]

habit_tracker_cli-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

habit_tracker_cli-0.1.0/src/habit_tracker_cli/__init__.py

@@ -0,0 +1,5 @@
+"""habit_tracker_cli package."""
+
+__all__ = ["__version__"]
+
+__version__ = "0.1.0"