makenote-cli 1.1.0__tar.gz

makenote_cli-1.1.0/LICENSE

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

makenote_cli-1.1.0/PKG-INFO

@@ -0,0 +1,145 @@
+Metadata-Version: 2.4
+Name: makenote-cli
+Version: 1.1.0
+Summary: Fast terminal note logging to GitHub
+Author-email: Hunter Finch <finchyhunter@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/hfinchy12/makenote
+Project-URL: Repository, https://github.com/hfinchy12/makenote
+Project-URL: Bug Tracker, https://github.com/hfinchy12/makenote/issues
+Keywords: notes,cli,github,productivity,terminal,journaling
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Utilities
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=8.1
+Requires-Dist: questionary>=2.0
+Dynamic: license-file
+
+# makenote
+
+Fast terminal note logging to GitHub. Log notes from your terminal and store them as JSONL files in a GitHub repo — no database, no server, just `gh` and Git.
+
+## Why
+
+Developers do a lot — shipped features, fixed bugs, unblocked teammates, learned something new — and most of it goes unrecorded. Come performance review time, or when updating your resume, that work is hard to reconstruct.
+
+`makenote` is a lightweight habit for capturing those moments as they happen. A two-second note from the terminal is low enough friction to actually stick. Over time, your notes become a running log of your progress and impact, stored in a GitHub repo you already own and can query however you like.
+
+## How it works
+
+`mn` appends timestamped notes to `notes/<subject>/notes.jsonl` in a GitHub repo you configure. Notes are stored as newline-delimited JSON records and written directly via the GitHub Contents API (through the `gh` CLI).
+
+## Requirements
+
+- Python 3.9+
+- [gh CLI](https://cli.github.com) — authenticated (`gh auth login`)
+- A GitHub repo to store your notes in
+
+## Installation
+
+### Homebrew (recommended)
+
+```bash
+brew tap hfinchy12/tap
+brew install makenote
+```
+
+### pip
+
+```bash
+pip install makenote
+```
+
+## Setup
+
+On first run, `mn` launches an interactive config wizard:
+
+```bash
+mn
+```
+
+Or run it explicitly at any time:
+
+```bash
+mn config
+```
+
+You'll be prompted to set:
+- **GitHub repo** — the `owner/repo` where notes will be stored
+- **Subjects** — categories for your notes (e.g. `work`, `ideas`, `todo`)
+- **Default subject** — used by `mn d` for fast logging
+
+Config is saved to `~/.config/makenote/config.json`.
+
+## Usage
+
+### Interactive note (with subject picker)
+
+```bash
+mn
+```
+
+Prompts you to select a subject, then enter your note.
+
+### Quick note to default subject
+
+```bash
+mn d "your note here"
+```
+
+Or without an argument to be prompted:
+
+```bash
+mn d
+```
+
+### List recent notes
+
+```bash
+mn list
+```
+
+Shows the 20 most recent notes across all subjects, sorted newest first.
+
+To filter by a specific subject:
+
+```bash
+mn list --subject work
+mn list -s ideas
+```
+
+### Edit config
+
+```bash
+mn config
+```
+
+### Version
+
+```bash
+mn --version
+```
+
+## Contributing
+
+Pull requests are welcome. For significant changes, please open an issue first to discuss the approach.
+
+1. Fork the repo
+2. Create a feature branch (`git checkout -b my-feature`)
+3. Make your changes
+4. Run the test suite (`pytest tests/ -x -q`)
+5. Open a pull request
+
+## License
+
+MIT

makenote_cli-1.1.0/README.md

@@ -0,0 +1,118 @@
+# makenote
+
+Fast terminal note logging to GitHub. Log notes from your terminal and store them as JSONL files in a GitHub repo — no database, no server, just `gh` and Git.
+
+## Why
+
+Developers do a lot — shipped features, fixed bugs, unblocked teammates, learned something new — and most of it goes unrecorded. Come performance review time, or when updating your resume, that work is hard to reconstruct.
+
+`makenote` is a lightweight habit for capturing those moments as they happen. A two-second note from the terminal is low enough friction to actually stick. Over time, your notes become a running log of your progress and impact, stored in a GitHub repo you already own and can query however you like.
+
+## How it works
+
+`mn` appends timestamped notes to `notes/<subject>/notes.jsonl` in a GitHub repo you configure. Notes are stored as newline-delimited JSON records and written directly via the GitHub Contents API (through the `gh` CLI).
+
+## Requirements
+
+- Python 3.9+
+- [gh CLI](https://cli.github.com) — authenticated (`gh auth login`)
+- A GitHub repo to store your notes in
+
+## Installation
+
+### Homebrew (recommended)
+
+```bash
+brew tap hfinchy12/tap
+brew install makenote
+```
+
+### pip
+
+```bash
+pip install makenote
+```
+
+## Setup
+
+On first run, `mn` launches an interactive config wizard:
+
+```bash
+mn
+```
+
+Or run it explicitly at any time:
+
+```bash
+mn config
+```
+
+You'll be prompted to set:
+- **GitHub repo** — the `owner/repo` where notes will be stored
+- **Subjects** — categories for your notes (e.g. `work`, `ideas`, `todo`)
+- **Default subject** — used by `mn d` for fast logging
+
+Config is saved to `~/.config/makenote/config.json`.
+
+## Usage
+
+### Interactive note (with subject picker)
+
+```bash
+mn
+```
+
+Prompts you to select a subject, then enter your note.
+
+### Quick note to default subject
+
+```bash
+mn d "your note here"
+```
+
+Or without an argument to be prompted:
+
+```bash
+mn d
+```
+
+### List recent notes
+
+```bash
+mn list
+```
+
+Shows the 20 most recent notes across all subjects, sorted newest first.
+
+To filter by a specific subject:
+
+```bash
+mn list --subject work
+mn list -s ideas
+```
+
+### Edit config
+
+```bash
+mn config
+```
+
+### Version
+
+```bash
+mn --version
+```
+
+## Contributing
+
+Pull requests are welcome. For significant changes, please open an issue first to discuss the approach.
+
+1. Fork the repo
+2. Create a feature branch (`git checkout -b my-feature`)
+3. Make your changes
+4. Run the test suite (`pytest tests/ -x -q`)
+5. Open a pull request
+
+## License
+
+MIT

makenote_cli-1.1.0/pyproject.toml

@@ -0,0 +1,43 @@
+[build-system]
+requires = ["setuptools>=68"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "makenote-cli"
+version = "1.1.0"
+requires-python = ">=3.9"
+description = "Fast terminal note logging to GitHub"
+readme = "README.md"
+license = "MIT"
+authors = [{ name = "Hunter Finch", email = "finchyhunter@gmail.com" }]
+keywords = ["notes", "cli", "github", "productivity", "terminal", "journaling"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Utilities",
+]
+dependencies = [
+    "click>=8.1",
+    "questionary>=2.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/hfinchy12/makenote"
+Repository = "https://github.com/hfinchy12/makenote"
+"Bug Tracker" = "https://github.com/hfinchy12/makenote/issues"
+
+[project.scripts]
+mn = "makenote.cli:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

makenote_cli-1.1.0/setup.cfg

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

makenote_cli-1.1.0/src/makenote/__init__.py

@@ -0,0 +1,2 @@
+from importlib.metadata import version
+__version__ = version("makenote")

makenote_cli-1.1.0/src/makenote/cli.py

@@ -0,0 +1,112 @@
+from __future__ import annotations
+
+import sys
+
+import click
+import questionary
+
+import makenote.config as _cfg
+import makenote.github as _gh
+
+
+@click.group(invoke_without_command=True)
+@click.version_option(package_name="makenote", prog_name="mn", message="%(prog)s %(version)s")
+@click.pass_context
+def main(ctx: click.Context) -> None:
+    """mn — fast terminal note logging."""
+    if not _cfg.config_exists() and ctx.invoked_subcommand != "config":
+        click.echo("No config found. Running first-time setup.")
+        _cfg.run_config_flow()
+    elif ctx.invoked_subcommand is None:
+        # Interactive note flow (mn with no subcommand)
+        cfg = _cfg.load_config()
+        subjects = cfg.get("subjects", [])
+        if not subjects:
+            click.echo("Error: no subjects configured. Run mn config to add subjects.")
+            sys.exit(1)
+        choices = ["Add New", questionary.Separator()] + subjects
+        subject = questionary.select("Subject:", choices=choices).ask()
+        if subject is None:
+            sys.exit(0)
+        if subject == "Add New":
+            subject = questionary.text("New subject name:").ask()
+            if subject is None:
+                sys.exit(0)
+            subject = subject.strip()
+            cfg["subjects"].append(subject)
+            _cfg.save_config(cfg)
+        note_text = questionary.text("Note:").ask()
+        if note_text is None:
+            sys.exit(0)
+        try:
+            _gh.write_note(cfg["repo"], subject, note_text)
+        except _gh.GhNotInstalledError:
+            click.echo("Error: gh CLI not found. Install from https://cli.github.com")
+            sys.exit(1)
+        except _gh.GhNotAuthError:
+            click.echo("Error: gh not authenticated. Run: gh auth login")
+            sys.exit(1)
+        except _gh.ShaConflictError:
+            click.echo("Error: write conflict — file may have changed. Try again.")
+            sys.exit(1)
+        click.echo("Note logged.")
+
+
+@main.command()
+def config() -> None:
+    """Edit configuration."""
+    _cfg.run_config_flow()
+
+
+@main.command(name="d")
+@click.argument("note_text", required=False, default=None)
+def default_note(note_text: str | None) -> None:
+    """Log a note using the default subject."""
+    cfg = _cfg.load_config()
+    subject = cfg["default_subject"]
+    if note_text is None:
+        note_text = questionary.text("Note:").ask()
+        if note_text is None:
+            sys.exit(0)
+    try:
+        _gh.write_note(cfg["repo"], subject, note_text)
+    except _gh.GhNotInstalledError:
+        click.echo("Error: gh CLI not found. Install from https://cli.github.com")
+        sys.exit(1)
+    except _gh.GhNotAuthError:
+        click.echo("Error: gh not authenticated. Run: gh auth login")
+        sys.exit(1)
+    except _gh.ShaConflictError:
+        click.echo("Error: write conflict — file may have changed. Try again.")
+        sys.exit(1)
+    click.echo("Note logged.")
+
+
+@main.command(name="list")
+@click.option("--subject", "-s", default=None, help="Filter notes to a single subject.")
+def list_notes(subject: str | None) -> None:
+    """Print recent notes across all subjects."""
+    cfg = _cfg.load_config()
+    subjects = cfg.get("subjects", [])
+    if subject is not None:
+        if subject not in subjects:
+            click.echo(f"Error: unknown subject '{subject}'. Run mn config to manage subjects.")
+            sys.exit(1)
+        subjects = [subject]
+    try:
+        records = _gh.read_notes(cfg["repo"], subjects)
+    except _gh.GhNotInstalledError:
+        click.echo("Error: gh CLI not found. Install from https://cli.github.com")
+        sys.exit(1)
+    except _gh.GhNotAuthError:
+        click.echo("Error: gh not authenticated. Run: gh auth login")
+        sys.exit(1)
+    except _gh.ShaConflictError:
+        click.echo("Error: write conflict — file may have changed. Try again.")
+        sys.exit(1)
+    if not records:
+        click.echo("No notes found.")
+        return
+    for r in records:
+        note_display = r["note"][:60] + "..." if len(r["note"]) > 60 else r["note"]
+        click.echo(f"{r['date']}  {r['subject']:<15}  {note_display}")

makenote_cli-1.1.0/src/makenote/config.py

@@ -0,0 +1,135 @@
+from __future__ import annotations
+
+import json
+import sys
+import time
+from pathlib import Path
+
+import click
+import questionary
+
+from makenote.github import GhError, list_subjects
+
+CONFIG_PATH = Path.home() / ".config" / "makenote" / "config.json"
+
+
+def config_exists() -> bool:
+    return CONFIG_PATH.exists()
+
+
+def load_config() -> dict:
+    with CONFIG_PATH.open() as f:
+        return json.load(f)
+
+
+def save_config(data: dict) -> None:
+    CONFIG_PATH.parent.mkdir(parents=True, exist_ok=True)
+    with CONFIG_PATH.open("w") as f:
+        json.dump(data, f, indent=2)
+
+
+def _offer_import_subjects(data: dict) -> None:
+    """Offer to import subjects found in the remote repo that aren't local yet."""
+    try:
+        remote_subjects = list_subjects(data["repo"])
+    except GhError as e:
+        click.echo(f"Warning: could not fetch remote subjects: {e}")
+        return
+
+    new_subjects = [s for s in remote_subjects if s not in data["subjects"]]
+    if not new_subjects:
+        return
+
+    subject_list = ", ".join(new_subjects)
+    answer = questionary.select(
+        f"Found {len(new_subjects)} subject(s) in remote repo: {subject_list}. Import all?",
+        choices=["Yes", "No"],
+    ).ask()
+    if answer is None:
+        return
+    confirmed = answer == "Yes"
+
+    if not confirmed:
+        return
+
+    data["subjects"].extend(new_subjects)
+    click.echo(f"Imported {len(new_subjects)} subject(s).")
+
+
+def run_config_flow(existing: dict | None = None) -> None:
+    """Interactive config editor. Loops until user selects Save and exit."""
+    data = existing.copy() if existing else {"repo": "", "default_subject": "", "subjects": []}
+
+    # Pre-load existing config if it exists and no data passed in
+    if existing is None and config_exists():
+        data = load_config()
+
+    while True:
+        action = questionary.select(
+            "Configure makenote:",
+            choices=[
+                "Set GitHub repo",
+                "Set default subject",
+                questionary.Separator(),
+                "Add subject",
+                "Remove subject",
+                "List subjects",
+                questionary.Separator(),
+                "Save and exit",
+            ],
+        ).ask()
+
+        if action is None:  # Ctrl-C: exit cleanly, no traceback
+            sys.exit(0)
+
+        if action == "Set GitHub repo":
+            repo = questionary.text("GitHub repo (owner/repo):").ask()
+            if repo is None:
+                sys.exit(0)
+            data["repo"] = repo.strip()
+            _offer_import_subjects(data)
+
+        elif action == "Set default subject":
+            if not data["subjects"]:
+                click.echo("Error: add at least one subject first.")
+                click.echo("")
+                continue
+            subject = questionary.select(
+                "Default subject:", choices=data["subjects"]
+            ).ask()
+            if subject is None:
+                sys.exit(0)
+            data["default_subject"] = subject
+
+        elif action == "Add subject":
+            name = questionary.text("New subject name:").ask()
+            if name is None:
+                sys.exit(0)
+            name = name.strip()
+            if name and name not in data["subjects"]:
+                data["subjects"].append(name)
+
+        elif action == "List subjects":
+            if not data["subjects"]:
+                click.echo("No subjects configured.")
+            else:
+                click.echo("\n".join(data["subjects"]))
+            time.sleep(0.4)
+
+        elif action == "Remove subject":
+            if not data["subjects"]:
+                click.echo("Error: no subjects to remove.")
+                click.echo("")
+                continue
+            to_remove = questionary.select(
+                "Remove which subject?", choices=data["subjects"]
+            ).ask()
+            if to_remove is None:
+                sys.exit(0)
+            data["subjects"].remove(to_remove)
+
+        elif action == "Save and exit":
+            save_config(data)
+            break
+
+        click.echo("")

makenote_cli-1.1.0/src/makenote/constants.py

@@ -0,0 +1,3 @@
+from pathlib import Path
+
+CONFIG_PATH = Path.home() / ".config" / "makenote" / "config.json"