prosaic-app 0.1.3__tar.gz

prosaic_app-0.1.3/LICENSE

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

prosaic_app-0.1.3/PKG-INFO

@@ -0,0 +1,168 @@
+Metadata-Version: 2.4
+Name: prosaic-app
+Version: 0.1.3
+Summary: A writer-first terminal writing app
+Author: Deepansh Khurana
+License: MIT
+Project-URL: Homepage, https://github.com/deepanshkhurana/prosaic
+Project-URL: Repository, https://github.com/deepanshkhurana/prosaic
+Keywords: writing,terminal,markdown,tui
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Text Editors
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: textual[syntax]>=0.50.0
+Requires-Dist: click>=8.1.0
+Requires-Dist: platformdirs>=4.0.0
+Requires-Dist: gitpython>=3.1.0
+Requires-Dist: pyspellchecker>=0.8.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+Requires-Dist: textual-dev>=1.0.0; extra == "dev"
+Provides-Extra: grammar
+Requires-Dist: language-tool-python>=2.8.0; extra == "grammar"
+Dynamic: license-file
+
+# Prosaic
+
+A writer-first terminal writing app built with Python and Textual, built with the assistance of LLM/Copilot tools.
+
+## Motivation
+
+I write on multiple devices (an iPad, a laptop, even more), and I wanted a quick way to start every day, get some frontmatter ready for my daily pieces on [journal.coffee](https://journal.coffee), jot down notes and even work on books. I have tried several software, some stellar, some half-assed, some bloated, some minimal, but I felt like I needed something of my own.
+
+So, I decided that the best way to go about it is to have a TUI. I can access it from anywhere, and mostly, it will do the job. This way, I can access it from a terminal app on the iPad or Windows (cue: Termix on a browser) and on the Macbook. Hence, Prosaic was born.
+
+**Full disclosure:** I did rely on LLMs to make it, but as much as I could, I tried to get it to follow best practices, good architecture, and clean code principles.
+
+## Publish with Ode
+
+Looking somewhere to publish your writing that is philosophically compatible with Prosaic? Check out [Ode](https://ode.dimwit.me/). You can also go to the [GitHub](https://github.com/DeepanshKhurana/ode/) directly. 
+
+> Ode is for writers who want to publish in an aesthetically pleasing website, ignoring the bells and whistles of the modern internet. It is opinionated, minimal, and easy to use, guided by an [Ethos](https://docs.ode.dimwit.me/ethos) that prioritizes the craft of writing and the joy of reading over metrics and engagement.
+
+## Screenshots
+
+| | |
+|---|---|
+| ![](media/light.png) | ![](media/dark.png) |
+| ![](media/light2.png) | ![](media/dark2.png) |
+| ![](media/light3.png) | ![](media/dark3.png) |
+
+## Installation
+
+```bash
+# Install (requires Python 3.11+)
+pipx install prosaic
+
+# Run (first launch runs setup wizard)
+prosaic
+
+# Re-run setup wizard anytime
+prosaic --setup
+```
+
+## Features
+
+- **Markdown-first**: Live outline, word counting
+- **Focus mode**: Hide everything except your writing
+- **Reader mode**: Distraction-free reading
+- **Continue writing**: Resume your last edited document
+- **Daily metrics**: Track words and characters written each day
+- **Git-ready**: Archive is Git-initialized for versioning
+
+## Keybindings
+
+| Category | Key | Action |
+|----------|-----|--------|
+| Dashboard | `c` | Continue writing (if last file exists) |
+| Dashboard | `p` | Write a piece |
+| Dashboard | `b` | Work on a book |
+| Dashboard | `n` | Add a note |
+| Dashboard | `r` | Read notes |
+| Dashboard | `f` | Find files |
+| Dashboard | `?` | Help |
+| Dashboard | `q` | Quit |
+| Editor | `Ctrl+e` | Toggle file tree |
+| Editor | `Ctrl+o` | Toggle outline |
+| Editor | `Ctrl+s` | Save |
+| Editor | `Ctrl+q` | Go home |
+| Editor | `F5` | Focus mode |
+| Editor | `F6` | Reader mode |
+| Writing | `Ctrl+z` | Undo |
+| Writing | `Ctrl+y` | Redo |
+| Writing | `Ctrl+x` | Cut |
+| Writing | `Ctrl+c` | Copy |
+| Writing | `Ctrl+v` | Paste |
+| Writing | `Ctrl+a` | Select all |
+
+## Themes
+
+- **Prosaic Light** (default): Warm white background with brick accents
+- **Prosaic Dark**: Deep charcoal with warm tan accents
+
+```bash
+# Light mode (default)
+prosaic
+
+# Dark mode
+prosaic --dark
+```
+
+## Configuration
+
+Config location (in order of priority):
+1. `PROSAIC_CONFIG_DIR` env var (explicit override)
+2. `$XDG_CONFIG_HOME/prosaic/` (Linux standard)
+3. `~/.config/prosaic/` (default)
+
+Override with environment variable:
+
+```bash
+PROSAIC_CONFIG_DIR=~/custom/path prosaic
+```
+
+### Git Integration
+
+If your chosen archive directory already contains a git repository, the wizard will:
+
+- Detect the existing `.git` directory
+- Inherit the repository (no re-initialization)
+- Read the remote URL if configured
+- Prompt for a remote URL if none exists
+- Store this info in `settings.json`
+
+Example `settings.json`:
+
+```json
+{
+  "setup_complete": true,
+  "archive_dir": "/Users/you/Prosaic",
+  "init_git": true,
+  "git_remote": "git@github.com:you/writing.git",
+  "git_inherited": true,
+  "last_file": "/Users/you/Prosaic/pieces/2026-02-21-example.md"
+}
+```
+
+## Archive Structure
+
+```
+~/Prosaic/              # Default archive (configurable)
+  pieces/               # Pieces with preloaded markdown frontmatter
+  books/                # Long-form projects with Outline already open
+  notes.md              # Quick notes with auto date headers
+  metrics.json          # Daily statistics for archival and display
+  .git/                 # Version control
+```
+
+## License
+
+MIT

prosaic_app-0.1.3/README.md

@@ -0,0 +1,136 @@
+# Prosaic
+
+A writer-first terminal writing app built with Python and Textual, built with the assistance of LLM/Copilot tools.
+
+## Motivation
+
+I write on multiple devices (an iPad, a laptop, even more), and I wanted a quick way to start every day, get some frontmatter ready for my daily pieces on [journal.coffee](https://journal.coffee), jot down notes and even work on books. I have tried several software, some stellar, some half-assed, some bloated, some minimal, but I felt like I needed something of my own.
+
+So, I decided that the best way to go about it is to have a TUI. I can access it from anywhere, and mostly, it will do the job. This way, I can access it from a terminal app on the iPad or Windows (cue: Termix on a browser) and on the Macbook. Hence, Prosaic was born.
+
+**Full disclosure:** I did rely on LLMs to make it, but as much as I could, I tried to get it to follow best practices, good architecture, and clean code principles.
+
+## Publish with Ode
+
+Looking somewhere to publish your writing that is philosophically compatible with Prosaic? Check out [Ode](https://ode.dimwit.me/). You can also go to the [GitHub](https://github.com/DeepanshKhurana/ode/) directly. 
+
+> Ode is for writers who want to publish in an aesthetically pleasing website, ignoring the bells and whistles of the modern internet. It is opinionated, minimal, and easy to use, guided by an [Ethos](https://docs.ode.dimwit.me/ethos) that prioritizes the craft of writing and the joy of reading over metrics and engagement.
+
+## Screenshots
+
+| | |
+|---|---|
+| ![](media/light.png) | ![](media/dark.png) |
+| ![](media/light2.png) | ![](media/dark2.png) |
+| ![](media/light3.png) | ![](media/dark3.png) |
+
+## Installation
+
+```bash
+# Install (requires Python 3.11+)
+pipx install prosaic
+
+# Run (first launch runs setup wizard)
+prosaic
+
+# Re-run setup wizard anytime
+prosaic --setup
+```
+
+## Features
+
+- **Markdown-first**: Live outline, word counting
+- **Focus mode**: Hide everything except your writing
+- **Reader mode**: Distraction-free reading
+- **Continue writing**: Resume your last edited document
+- **Daily metrics**: Track words and characters written each day
+- **Git-ready**: Archive is Git-initialized for versioning
+
+## Keybindings
+
+| Category | Key | Action |
+|----------|-----|--------|
+| Dashboard | `c` | Continue writing (if last file exists) |
+| Dashboard | `p` | Write a piece |
+| Dashboard | `b` | Work on a book |
+| Dashboard | `n` | Add a note |
+| Dashboard | `r` | Read notes |
+| Dashboard | `f` | Find files |
+| Dashboard | `?` | Help |
+| Dashboard | `q` | Quit |
+| Editor | `Ctrl+e` | Toggle file tree |
+| Editor | `Ctrl+o` | Toggle outline |
+| Editor | `Ctrl+s` | Save |
+| Editor | `Ctrl+q` | Go home |
+| Editor | `F5` | Focus mode |
+| Editor | `F6` | Reader mode |
+| Writing | `Ctrl+z` | Undo |
+| Writing | `Ctrl+y` | Redo |
+| Writing | `Ctrl+x` | Cut |
+| Writing | `Ctrl+c` | Copy |
+| Writing | `Ctrl+v` | Paste |
+| Writing | `Ctrl+a` | Select all |
+
+## Themes
+
+- **Prosaic Light** (default): Warm white background with brick accents
+- **Prosaic Dark**: Deep charcoal with warm tan accents
+
+```bash
+# Light mode (default)
+prosaic
+
+# Dark mode
+prosaic --dark
+```
+
+## Configuration
+
+Config location (in order of priority):
+1. `PROSAIC_CONFIG_DIR` env var (explicit override)
+2. `$XDG_CONFIG_HOME/prosaic/` (Linux standard)
+3. `~/.config/prosaic/` (default)
+
+Override with environment variable:
+
+```bash
+PROSAIC_CONFIG_DIR=~/custom/path prosaic
+```
+
+### Git Integration
+
+If your chosen archive directory already contains a git repository, the wizard will:
+
+- Detect the existing `.git` directory
+- Inherit the repository (no re-initialization)
+- Read the remote URL if configured
+- Prompt for a remote URL if none exists
+- Store this info in `settings.json`
+
+Example `settings.json`:
+
+```json
+{
+  "setup_complete": true,
+  "archive_dir": "/Users/you/Prosaic",
+  "init_git": true,
+  "git_remote": "git@github.com:you/writing.git",
+  "git_inherited": true,
+  "last_file": "/Users/you/Prosaic/pieces/2026-02-21-example.md"
+}
+```
+
+## Archive Structure
+
+```
+~/Prosaic/              # Default archive (configurable)
+  pieces/               # Pieces with preloaded markdown frontmatter
+  books/                # Long-form projects with Outline already open
+  notes.md              # Quick notes with auto date headers
+  metrics.json          # Daily statistics for archival and display
+  .git/                 # Version control
+```
+
+## License
+
+MIT

prosaic_app-0.1.3/prosaic/__init__.py

@@ -0,0 +1,3 @@
+"""Prosaic - A writer-first terminal writing app."""
+
+__version__ = "0.1.0"

prosaic_app-0.1.3/prosaic/__main__.py

@@ -0,0 +1,149 @@
+"""Entry point for Prosaic."""
+
+from pathlib import Path
+
+import click
+from textual.app import App
+from textual.binding import Binding
+
+from prosaic.app import HelpScreen, NewBookModal, NewPieceModal
+from prosaic.config import (
+    ensure_workspace,
+    get_notes_path,
+    get_workspace_dir,
+    save_config,
+    set_last_file,
+)
+from prosaic.core.metrics import MetricsTracker
+from prosaic.screens import DashboardScreen, EditorScreen
+from prosaic.themes import PROSAIC_DARK_CSS, PROSAIC_LIGHT_CSS
+from prosaic.widgets import SpellCheckTextArea
+from prosaic.wizard import needs_setup, run_setup, setup_workspace
+
+
+class ProsaicApp(App):
+    """Main Prosaic application."""
+
+    TITLE = "prosaic"
+    CSS = PROSAIC_LIGHT_CSS
+    BINDINGS = [
+        Binding("ctrl+q", "smart_quit", "quit", show=False, priority=True),
+    ]
+
+    def __init__(
+        self,
+        light_mode: bool = True,
+        initial_file: Path | None = None,
+    ) -> None:
+        super().__init__()
+        self.light_mode = light_mode
+        self.initial_file = initial_file
+        self.notes_path = get_notes_path()
+        ProsaicApp.CSS = PROSAIC_LIGHT_CSS if light_mode else PROSAIC_DARK_CSS
+
+    def on_mount(self) -> None:
+        ensure_workspace()
+        self.metrics = MetricsTracker(get_workspace_dir())
+        self.install_screen(DashboardScreen(self.metrics), name="dashboard")
+
+        if self.initial_file:
+            self._open_editor(self.initial_file)
+        else:
+            self.push_screen("dashboard")
+
+    def _open_editor(self, file_path: Path | None = None, show_all_panes: bool = False) -> None:
+        if file_path:
+            set_last_file(file_path)
+
+        self.push_screen(
+            EditorScreen(
+                self.metrics,
+                initial_file=file_path,
+                light_mode=self.light_mode,
+                show_all_panes=show_all_panes,
+            )
+        )
+
+    def _open_notes(self) -> None:
+        self.push_screen(
+            EditorScreen(
+                self.metrics,
+                initial_file=self.notes_path,
+                light_mode=self.light_mode,
+                add_note=True,
+            )
+        )
+
+    def _open_notes_readonly(self) -> None:
+        self.push_screen(
+            EditorScreen(
+                self.metrics,
+                initial_file=self.notes_path,
+                light_mode=self.light_mode,
+                reader_mode_initial=True,
+            )
+        )
+
+    def _handle_new_piece(self, result: Path | None) -> None:
+        if result:
+            self._open_editor(result)
+
+    def _handle_new_book(self, result: Path | None) -> None:
+        if result:
+            self._open_editor(result)
+
+    def action_new_piece(self) -> None:
+        self.push_screen(NewPieceModal(), callback=self._handle_new_piece)
+
+    def action_new_book(self) -> None:
+        self.push_screen(NewBookModal(), callback=self._handle_new_book)
+
+    def toggle_theme(self) -> None:
+        self.light_mode = not self.light_mode
+        ProsaicApp.CSS = PROSAIC_LIGHT_CSS if self.light_mode else PROSAIC_DARK_CSS
+        self.refresh_css(animate=False)
+
+        try:
+            screen = self.screen
+            if isinstance(screen, EditorScreen):
+                ta = screen.query_one("#editor", SpellCheckTextArea)
+                ta.theme = "prosaic_light" if self.light_mode else "prosaic_dark"
+                ta._build_highlight_map()
+        except Exception:
+            pass
+
+    async def action_quit(self) -> None:
+        self.exit()
+
+    def action_smart_quit(self) -> None:
+        screen = self.screen
+        if isinstance(screen, EditorScreen):
+            screen.action_go_home()
+        elif isinstance(screen, DashboardScreen):
+            self.exit()
+        elif len(self.screen_stack) > 1:
+            self.pop_screen()
+        else:
+            self.exit()
+
+
+@click.command()
+@click.option("--light/--dark", default=True, help="Use light or dark theme")
+@click.option("--setup", is_flag=True, help="Run setup wizard again")
+@click.argument("file", required=False, type=click.Path())
+def main(light: bool, setup: bool, file: str | None) -> None:
+    """Prosaic - A writer-first terminal writing app."""
+    if setup or needs_setup():
+        config = run_setup()
+        save_config(config)
+        setup_workspace(config)
+
+    app = ProsaicApp(
+        light_mode=light,
+        initial_file=Path(file) if file else None,
+    )
+    app.run()
+
+
+if __name__ == "__main__":
+    main()