pynotes-cli 0.1.0__tar.gz

pynotes_cli-0.1.0/PKG-INFO

@@ -0,0 +1,8 @@
+Metadata-Version: 2.4
+Name: pynotes-cli
+Version: 0.1.0
+Summary: A terminal Markdown personal journal and notes tool.
+Requires-Python: >=3.9
+Requires-Dist: typer>=0.9.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: questionary>=2.0.0

pynotes_cli-0.1.0/README.md

@@ -0,0 +1,84 @@
+# Pynotes
+
+Pynotes is a lightning-fast terminal-based Markdown personal journal and notes tool. It allows you to seamlessly create, read, list, and filter your notes directly from the command line, while storing everything locally in a lightweight SQLite database.
+
+## What it Does
+
+- **Create & Edit**: Interactively create notes with titles, tags, and Markdown content. Edit existing notes smoothly.
+- **List & Filter**: View all your notes in a beautifully formatted table or filter them down by specific tags.
+- **View Notes**: Render your notes with full Markdown syntax highlighting right in your terminal.
+- **Local Storage**: Keeps all your data secure and accessible on your local machine (`~/.pynotes.db`).
+
+## Project Structure
+
+```text
+pynotes/
+├── pyproject.toml      # Project metadata and dependencies configuration
+├── README.md           # Project documentation and instructions
+└── pynotes/            # Main application package
+    ├── __init__.py     # Marks the directory as a Python package
+    ├── main.py         # Entry point defining the CLI commands using Typer
+    ├── db.py           # Handles SQLite database connection and queries
+    ├── ui.py           # Manages terminal output rendering using Rich
+    └── prompts.py      # Handles interactive user inputs using Questionary
+```
+
+## Tech Stack
+
+- **[Python 3.10+](https://www.python.org/)**
+- **[Typer](https://typer.tiangolo.com/)**: For building the powerful command-line interface.
+- **[Rich](https://rich.readthedocs.io/)**: For beautiful terminal formatting, tables, and Markdown rendering.
+- **[Questionary](https://questionary.readthedocs.io/)**: For interactive and user-friendly CLI prompts.
+- **[SQLite3](https://docs.python.org/3/library/sqlite3.html)**: For local database storage (built-in).
+
+## Instructions to Run
+
+### 1. Installation
+
+It is recommended to install `pynotes` in editable mode so that you can easily access the CLI from anywhere in your terminal.
+
+```bash
+# Clone the repository and navigate to the directory
+cd path/to/pynotes
+
+# Install the package and its dependencies
+pip install -e .
+```
+
+### 2. Usage
+
+Once installed, the `pynotes` command will be globally available in your terminal environment.
+
+**Initialize the Database:**
+Initialize your local database at `~/.pynotes.db`.
+```bash
+pynotes init
+```
+
+**Create a New Note:**
+```bash
+pynotes new
+```
+Follow the interactive prompts to add your title, tags, and Markdown content. Press `Alt+Enter` (or `Esc` then `Enter` on Mac) to save the content.
+
+**List All Notes:**
+```bash
+pynotes list
+```
+
+**Filter Notes by Tag:**
+```bash
+pynotes list --tag <your-tag>
+```
+
+**View a Specific Note:**
+View the full rendered Markdown of a note by providing its ID.
+```bash
+pynotes view <note_id>
+```
+
+**Edit a Note:**
+Edit the title, tags, or content of an existing note.
+```bash
+pynotes edit <note_id>
+```

pynotes_cli-0.1.0/pynotes/db.py

@@ -0,0 +1,50 @@
+import sqlite3
+from pathlib import Path
+
+DB_PATH = Path.home() / ".pynotes.db"
+
+def get_connection():
+    return sqlite3.connect(DB_PATH)
+
+def init_db():
+    with get_connection() as conn:
+        conn.execute("""
+            CREATE TABLE IF NOT EXISTS notes (
+                id INTEGER PRIMARY KEY AUTOINCREMENT,
+                title TEXT NOT NULL,
+                tags TEXT NOT NULL,
+                content TEXT NOT NULL,
+                created_at DATE DEFAULT CURRENT_DATE
+            )
+        """)
+
+def add_note(title: str, tags: str, content: str):
+    with get_connection() as conn:
+        conn.execute(
+            "INSERT INTO notes (title, tags, content) VALUES (?, ?, ?)",
+            (title, tags, content)
+        )
+
+def get_notes(tag: str = None):
+    with get_connection() as conn:
+        if tag:
+            # Simple wildcard search for tags
+            return conn.execute(
+                "SELECT id, title, tags, created_at FROM notes WHERE tags LIKE ?", 
+                (f"%{tag}%",)
+            ).fetchall()
+        return conn.execute("SELECT id, title, tags, created_at FROM notes").fetchall()
+
+def get_note(note_id: int):
+    with get_connection() as conn:
+        return conn.execute(
+            "SELECT title, tags, content FROM notes WHERE id = ?", 
+            (note_id,)
+        ).fetchone()
+
+def update_note(note_id: int, title: str, tags: str, content: str):
+    with get_connection() as conn:
+        conn.execute(
+            "UPDATE notes SET title = ?, tags = ?, content = ? WHERE id = ?",
+            (title, tags, content, note_id)
+        )

pynotes_cli-0.1.0/pynotes/main.py

@@ -0,0 +1,57 @@
+import typer
+from pynotes import db, ui, prompts
+
+app = typer.Typer(help="A lightning-fast terminal Markdown journal.")
+
+@app.callback()
+def main_callback():
+    db.init_db()
+
+@app.command()
+def init():
+    ui.display_success("Knowledge base initialized at ~/.pynotes.db")
+
+@app.command()
+def new():
+    note_data = prompts.prompt_new_note()
+    
+    if note_data and note_data["title"]:
+        db.add_note(note_data["title"], note_data["tags"], note_data["content"])
+        ui.display_success("Note saved successfully!")
+    else:
+        ui.display_error("Note creation cancelled.")
+
+@app.command(name="list")
+def list_notes(tag: str = typer.Option(None, help="Filter notes by tag")):
+    #list notes ( and filter tag)
+    notes = db.get_notes(tag)
+    ui.display_notes_table(notes)
+
+@app.command()
+def view(note_id: int):
+    note = db.get_note(note_id)
+
+    #view note w/ id
+    if note:
+        ui.display_note(title=note[0], content=note[2])
+    else:
+        ui.display_error(f"Note with ID {note_id} not found.")
+
+@app.command()
+def edit(note_id: int):
+    note = db.get_note(note_id)
+    if not note:
+        ui.display_error(f"Note with ID {note_id} not found.")
+        return
+        
+    ui.display_success(f"Editing note: {note[0]}")
+    note_data = prompts.prompt_edit_note(existing_title=note[0], existing_tags=note[1], existing_content=note[2])
+    
+    if note_data and note_data["title"]:
+        db.update_note(note_id, note_data["title"], note_data["tags"], note_data["content"])
+        ui.display_success("Note updated successfully!")
+    else:
+        ui.display_error("Note edit cancelled.")
+
+if __name__ == "__main__":
+    app()

pynotes_cli-0.1.0/pynotes/prompts.py

@@ -0,0 +1,59 @@
+import questionary
+
+def prompt_new_note():
+    title = questionary.text("Enter note title:").ask()
+    if not title:
+        return None
+    
+    tags = questionary.text("Enter tags (comma separated):").ask()
+    
+    # multiline=True allows hitting Enter for new lines. 
+    # The user presses Alt+Enter (or Esc then Enter on Mac) to submit.
+    content = questionary.text(
+        "Content (Markdown supported - Press Alt+Enter to save):", 
+        multiline=True
+    ).ask()
+    
+    return {
+        "title": title,
+        "tags": tags,
+        "content": content
+    }
+
+def prompt_edit_note(existing_title: str, existing_tags: str, existing_content: str):
+    title = questionary.text("Edit note title:", default=existing_title).ask()
+    if not title:
+        return None
+    
+    tags = questionary.text("Edit tags (comma separated):", default=existing_tags).ask()
+    
+    content = questionary.text(
+        "Edit Content (Markdown supported - Press Alt+Enter to save):", 
+        default=existing_content,
+        multiline=True
+    ).ask()
+    
+    return {
+        "title": title,
+        "tags": tags,
+        "content": content
+    }
+
+def prompt_edit_note(existing_title: str, existing_tags: str, existing_content: str):
+    title = questionary.text("Edit note title:", default=existing_title).ask()
+    if not title:
+        return None
+    
+    tags = questionary.text("Edit tags (comma separated):", default=existing_tags).ask()
+    
+    content = questionary.text(
+        "Edit Content (Markdown supported - Press Alt+Enter to save):", 
+        default=existing_content,
+        multiline=True
+    ).ask()
+    
+    return {
+        "title": title,
+        "tags": tags,
+        "content": content
+    }

pynotes_cli-0.1.0/pynotes/ui.py

@@ -0,0 +1,35 @@
+from rich.console import Console
+from rich.table import Table
+from rich.markdown import Markdown
+from rich import box
+
+console = Console()
+
+def display_notes_table(notes):
+    if not notes:
+        console.print("[yellow]No notes found.[/yellow]")
+        return
+
+    table = Table(title="Pynotes", box=box.SIMPLE)
+    table.add_column("ID", justify="right", style="cyan", no_wrap=True)
+    table.add_column("Title", style="magenta")
+    table.add_column("Tags", style="green")
+    table.add_column("Date", style="dim")
+
+    for note in notes:
+        table.add_row(str(note[0]), note[1], note[2], note[3])
+
+    console.print(table)
+
+def display_note(title: str, content: str):
+    console.print(f"\n[magenta]# {title}[/magenta]")
+    console.print("-" * 50)
+    # Renders the text as actual markdown (bolding, code blocks, etc.)
+    console.print(Markdown(content))
+    console.print("\n")
+    
+def display_success(message: str):
+    console.print(f"[green]✔ {message}[/green]")
+    
+def display_error(message: str):
+    console.print(f"[red]✖ {message}[/red]")

pynotes_cli-0.1.0/pynotes_cli.egg-info/PKG-INFO

@@ -0,0 +1,8 @@
+Metadata-Version: 2.4
+Name: pynotes-cli
+Version: 0.1.0
+Summary: A terminal Markdown personal journal and notes tool.
+Requires-Python: >=3.9
+Requires-Dist: typer>=0.9.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: questionary>=2.0.0

pynotes_cli-0.1.0/pynotes_cli.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+README.md
+pyproject.toml
+pynotes/__init__.py
+pynotes/db.py
+pynotes/main.py
+pynotes/prompts.py
+pynotes/ui.py
+pynotes_cli.egg-info/PKG-INFO
+pynotes_cli.egg-info/SOURCES.txt
+pynotes_cli.egg-info/dependency_links.txt
+pynotes_cli.egg-info/entry_points.txt
+pynotes_cli.egg-info/requires.txt
+pynotes_cli.egg-info/top_level.txt

pynotes_cli-0.1.0/pynotes_cli.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

pynotes_cli-0.1.0/pynotes_cli.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+pynotes = pynotes.main:app

pynotes_cli-0.1.0/pynotes_cli.egg-info/requires.txt

@@ -0,0 +1,3 @@
+typer>=0.9.0
+rich>=13.0.0
+questionary>=2.0.0

pynotes_cli-0.1.0/pynotes_cli.egg-info/top_level.txt

@@ -0,0 +1 @@
+pynotes

pynotes_cli-0.1.0/pyproject.toml

@@ -0,0 +1,17 @@
+[project]
+name = "pynotes-cli"
+version = "0.1.0"
+description = "A terminal Markdown personal journal and notes tool."
+requires-python = ">=3.9"
+dependencies = [
+    "typer>=0.9.0",
+    "rich>=13.0.0",
+    "questionary>=2.0.0"
+]
+
+[project.scripts]
+pynotes = "pynotes.main:app"
+
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"

pynotes_cli-0.1.0/setup.cfg

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