Writer-Reader
Segment-based book manuscript editor with git integration.
Overview
Writer-Reader breaks book chapters into individual markdown segments for granular editing, with built-in git integration for tracking changes.
Features:
- 📖 Segment chapters into editable markdown files
- ✏️ In-browser editing with live preview
- 🔀 Git integration (status, diff, commit, push)
- 📁 Convention-based file organization
- 🔄 Assemble segments back into chapters
Installation
pip install writer-reader
Or install from source:
git clone https://github.com/bobmatnyc/writer-reader.git
cd writer-reader
pip install -e .
Quick Start
1. Initialize a new project
writer-reader init my-book --title "My Book" --author "My Name"
cd my-book
2. Add your chapters
Place markdown files in chapters/:
my-book/
├── chapters/
│ ├── chapter-01-introduction.md
│ ├── chapter-02-the-beginning.md
│ └── ...
3. Segment chapters
writer-reader segment
Creates:
my-book/
├── segments/
│ ├── ch01-introduction/
│ │ ├── _meta.yaml
│ │ ├── 01-introduction.md
│ │ ├── 02-the-beginning.md
│ │ └── ...
│ └── _index.yaml
4. Start the editor
writer-reader serve
Open http://localhost:5555
File Convention
segments/
├── ch01-chapter-title/
│ ├── _meta.yaml # Chapter metadata
│ ├── 01-opening.md # First segment
│ ├── 02-section-name.md # Named section
│ └── ...
├── ch02-next-chapter/
│ └── ...
└── _index.yaml # Master index
Segment Types
- chapter-title: The
# Chapter N: Titleheading - section:
## Section Nameheaders - prose: Content between
---dividers
Metadata Format
_meta.yaml:
chapter: 1
title: The Beginning
source_file: chapter-01-the-beginning.md
segments:
- file: 01-the-beginning.md
title: "The Beginning"
type: chapter-title
index: 1
- file: 02-first-section.md
title: "First Section"
type: section
index: 2
CLI Commands
| Command | Description |
|---|---|
writer-reader init <dir> |
Initialize a new manuscript project |
writer-reader segment [dir] |
Segment chapters into individual files |
writer-reader serve |
Start the editor server |
writer-reader assemble [dir] |
Assemble segments back into chapters |
Options
# Serve on different port
writer-reader serve --port 8080
# Segment with force overwrite
writer-reader segment --force
# Assemble specific chapter
writer-reader assemble --chapter 5
API Endpoints
| Endpoint | Method | Description |
|---|---|---|
/api/index |
GET | Get all chapters/segments |
/api/chapter/<num> |
GET | Get chapter metadata |
/api/segment/<path> |
GET | Read segment content |
/api/segment/<path> |
PUT | Write segment content |
/api/git/status |
GET | Git status |
/api/git/diff |
GET | Show uncommitted changes |
/api/git/add |
POST | Stage files |
/api/git/commit |
POST | Commit with message |
/api/git/push |
POST | Push to remote |
/api/assemble/<num> |
GET | Preview assembled chapter |
/api/assemble/<num> |
POST | Save assembled chapter |
Development
# Clone repository
git clone https://github.com/bobmatnyc/writer-reader.git
cd writer-reader
# Install with dev dependencies
pip install -e ".[dev]"
# Run tests
pytest
# Format code
black src/
ruff check src/ --fix
Version History
- 0.1.0 - Initial release
- Chapter segmentation
- In-browser editing
- Git integration
- CLI commands
License
MIT License - see LICENSE for details.
Author
Bob Matsuoka (@bobmatnyc)
Metadata
Release files for writer-reader 0.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| writer_reader-0.1.1.tar.gz | 584.6 kB | Without provenance | Details for writer_reader-0.1.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| writer_reader-0.1.1-py3-none-any.whl | Python 3 | none | any | Details for writer_reader-0.1.1-py3-none-any.whl |
Total release size: 600.8 kB
Release files / writer_reader-0.1.1.tar.gz
| Download URL | writer_reader-0.1.1.tar.gz |
|---|---|
| Size | 584.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
11707757172ae2b9a6bd0f1f807bc1e58fc49a7a039576213ba7dd1c0b4315da
|
|
BLAKE2b-256 checksum How to use checksums |
999b92d906eb8fa06f6ad0928403e39500120cc69110835d865f3ccdc91cec3d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.14.2
|
Release files / writer_reader-0.1.1-py3-none-any.whl
| Download URL | writer_reader-0.1.1-py3-none-any.whl |
|---|---|
| Size | 16.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ca2e15e7cb7620e809a38c0831bc0b36c2331343a70c4a50cb9ca515c4cdc166
|
|
BLAKE2b-256 checksum How to use checksums |
da73d49a3f52ad12d3d62aa3e0b51ed8de2659c72cbd861d7ec579db14bef62b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.14.2
|
Security for writer-reader 0.1.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.