Skip to main content

Akademik ve teknik kitap üretim stüdyosu

Project description

bookMaker

LLM-assisted, author-controlled, quality-gated academic/technical book production studio.

book_manifest.yaml  →  6-stage pipeline  →  DOCX / PDF / EPUB / HTML
                    →  Studio GUI (localhost:8765)

Quick mental model

The framework is separate from book projects.

The framework (this repo): CLI, Studio GUI, generation pipeline, validation, release/export, supporting modules.

A book project (outside this repo): book-specific manifest, chapter manifests, prompts, drafts, finals, logs, exports. Lives at ~/projects/books/<name>/.


Start here

For agents and first-time users:

File Purpose
START_HERE.md Identity, pipeline overview, safe commands
AI_CONTEXT.md Compact mental model for agents
.llm/reading_order.md Task-specific reading order
docs/INDEX.md Full documentation index
AGENTS.md Full operating rules for coding agents

What bookMaker produces

  • Validated LLM-generated chapter drafts (Markdown)
  • Author-approved final chapters
  • Structured book exports: DOCX, PDF, EPUB, HTML
  • Quality reports, critique logs, release tags

Canonical book production pipeline

SPEC → VALIDATE → SEED → NORMALIZE → ENRICH → ASSEMBLE
Stage What happens
SPEC Build chapter specification from manifest
VALIDATE Validate spec before generating
SEED Generate initial chapter content
NORMALIZE Clean and structure raw output
ENRICH Add code examples, diagrams, callouts
ASSEMBLE Combine into final draft.md

Installation

git clone https://github.com/bmdersleri/bookMaker.git
cd bookMaker
uv sync
uv run pre-commit install

Requirements: Python 3.12+, uv, Pandoc (for export), Node.js + npm (optional), mmdc (Mermaid, optional).


Minimal commands

# Start Studio GUI (http://localhost:8765)
uv run python -m bookmaker.studio.app

# Validate a book project (safe, no LLM calls)
uv run bookmaker check book <book-dir>

# Check toolchain
uv run bookmaker check toolchain

# Run fast tests
just fast

Documentation

File Purpose
docs/00_BIG_PICTURE.md Problem space, actors, artifacts
docs/01_BOOK_PRODUCTION_FLOW.md Step-by-step production guide
docs/02_PROJECT_LAYOUT.md Repo + book project layout
docs/03_COMMANDS.md Command reference (safe vs costly)
docs/05_ARCHITECTURE_MAP.md Compact module map
docs/architecture.md Full architecture reference
docs/pipeline.md Pipeline stage deep-dive
docs/studio.md Studio GUI feature reference
docs/release.md Release/export module
docs/AI_COPILOT_OPENCODE.md OpenCode Copilot Integration
STATUS.md Current project state
CHANGELOG.md Version history

Agent onboarding

Agents new to this repository should read in this order:

  1. START_HERE.md
  2. AI_CONTEXT.md
  3. .llm/reading_order.md
  4. docs/01_BOOK_PRODUCTION_FLOW.md
  5. docs/02_PROJECT_LAYOUT.md
  6. AGENTS.md

See examples/minimal-book/ for a minimal valid book project layout.


Development validation

# Lint
uv run ruff check src/ tests/

# Fast test suite
just fast

# Full test suite
uv run pytest tests/ -q --tb=short

# Validate example book project
uv run bookmaker check book examples/minimal-book --json

Safety notes

  • book_manifest.yaml is the single config source — everything else is derived.
  • Do not run bookmaker generate * without explicit user approval (LLM API calls).
  • Never commit .env, llm_config.json, or .claude/settings.local.json.
  • Generated draft.md and pipeline_state.yaml are pipeline outputs — do not manually edit.
  • Book projects live outside this repo (~/projects/books/ or $BOOKMAKER_PROJECTS_DIR).

Studio GUI tabs

Tab Features
Bölümler Chapter table, drag-drop reorder, inline edit, bulk delete, add wizard
Pipeline Manual trigger, live progress, job detail panel, cancel, job history
Kalite Quality summary (score/decision/errors/warnings), chapter table, full-text search
Build/Export Export targets, readiness pre-check, code validation, Mermaid render, format export
Promptlar Default/chapter prompt editor, dirty-state warning, load/save
Yapılandırma book_manifest.yaml full editor (Book, Production, Style, Automation, Export subtabs)
Manifest Üret 8-agent manifest generation wizard (Architect→Pedagog→Debate→Engineer→Coder→Assessor→Editor→Author→CoherenceChecker)
Araştırma Arxiv/Crossref/Semantic Scholar source suggestion + approval
Hafıza sqlite-vec vector recall, reindex, stats, reviewer feedback log
Hakem Profile/chapter selection, LLM reviewer simulation, feedback save
Release Readiness check, approve/unapprove chapters, tag version, export

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bookmaker_studio-0.4.0.tar.gz (12.6 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bookmaker_studio-0.4.0-py3-none-any.whl (512.3 kB view details)

Uploaded Python 3

File details

Details for the file bookmaker_studio-0.4.0.tar.gz.

File metadata

  • Download URL: bookmaker_studio-0.4.0.tar.gz
  • Upload date:
  • Size: 12.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for bookmaker_studio-0.4.0.tar.gz
Algorithm Hash digest
SHA256 cdde8d0b7bb72d49acecce8d8c4aae6562419a50833bb5f96df50b65b146a822
MD5 3090004ef4560e25670685cc2fb254fc
BLAKE2b-256 b385778fe48c183c15bceac69d6e226a82d5695a4caad46eb035e5844114e4a5

See more details on using hashes here.

File details

Details for the file bookmaker_studio-0.4.0-py3-none-any.whl.

File metadata

File hashes

Hashes for bookmaker_studio-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8ac7eef71cc46e8d0d6f3f5744761e6f60add26f79d7492dbcae73d5e2b361c6
MD5 31045ecde874873ee18b5a92189ed922
BLAKE2b-256 71de9e245532889a5a0e7aeaa7b4d26a2520fcfea93cdf990dafc539fd9ec6bb

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page