coronelli 0.1.0__tar.gz

coronelli-0.1.0/.gitignore

@@ -0,0 +1,46 @@
+# Private product-development material
+/.planning/
+CLAUDE.local.md
+
+# Private workspace data — never commit corpus material or derived artifacts
+/data/private/*
+!/data/private/.gitkeep
+/exports/private/*
+!/exports/private/.gitkeep
+*.atlas.private
+
+# Environment variables
+.env
+.env.local
+.env.*.local
+
+# SQLite databases (local dev workspace)
+*.db
+*.db-shm
+*.db-wal
+
+# Python
+__pycache__/
+*.py[cod]
+*.pyo
+.pytest_cache/
+*.egg-info/
+dist/
+.venv/
+venv/
+
+# Built frontend (generated by pnpm build — packaged into wheel, not committed)
+/apps/api/app/static/
+
+# Node / pnpm
+node_modules/
+dist/
+.pnpm-store/
+.vite/
+
+# Editor
+.vscode/
+.idea/
+*.swp
+*.swo
+*.tsbuildinfo

coronelli-0.1.0/PKG-INFO

@@ -0,0 +1,112 @@
+Metadata-Version: 2.5
+Name: coronelli
+Version: 0.1.0
+Summary: Turn a book into an interactive atlas.
+Project-URL: Homepage, https://github.com/JanviChawla/coronelli
+Project-URL: Repository, https://github.com/JanviChawla/coronelli
+Keywords: atlas,fiction,literature,maps,nlp
+Requires-Python: >=3.12
+Requires-Dist: alembic
+Requires-Dist: fastapi
+Requires-Dist: jsonschema
+Requires-Dist: openai
+Requires-Dist: pymupdf
+Requires-Dist: python-dotenv
+Requires-Dist: python-multipart
+Requires-Dist: sqlalchemy
+Requires-Dist: uvicorn[standard]
+Provides-Extra: dev
+Requires-Dist: httpx; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Coronelli ◉
+
+A literary atlas builder — upload a book and explore its world in 3D.
+
+Coronelli is inspired by the craft of historical cartographers: it reads a novel section by section, finds every named place, maps spatial relationships and visual qualities, and builds a navigable world you can orbit and inspect.
+
+```
+Upload → Catalog → Extract → Synthesize → Atlas Editor → 3D Explorer
+```
+
+- Import `.txt`, `.md`, and text-bearing `.pdf` files
+- LLM pipeline identifies places, containment hierarchies, spatial claims, and visual details
+- Every extracted candidate is held for human review before it becomes canonical
+- Edit the atlas — rename entities, merge duplicates, assign hierarchy, add relationships
+- Explore in an interactive 3D scene: zone rings, floating nodes, force-directed layout
+
+## Installation
+
+Requires Python 3.12+. Install with [uv](https://docs.astral.sh/uv/):
+
+```sh
+uv tool install coronelli
+```
+
+Then launch:
+
+```sh
+coronelli
+```
+
+Coronelli opens in your browser at `http://localhost:8000`. Your atlas data is stored locally:
+
+| Platform | Location |
+|----------|----------|
+| Windows  | `%LOCALAPPDATA%\Coronelli\coronelli.db` |
+| macOS    | `~/Library/Application Support/Coronelli/coronelli.db` |
+| Linux    | `~/.local/share/Coronelli/coronelli.db` |
+
+Set your OpenAI API key before running extraction:
+
+```sh
+# in your shell profile, or in %LOCALAPPDATA%\Coronelli\.env  (Windows)
+#                                ~/Library/Application Support/Coronelli/.env  (macOS)
+OPENAI_API_KEY=sk-...
+```
+
+## Requirements (for development)
+
+- Python 3.12+, [uv](https://docs.astral.sh/uv/)
+- Node 20+, pnpm 9+
+- OpenAI API key
+
+## Setup
+
+```sh
+# Backend
+cd apps/api
+uv sync --extra dev
+
+# Frontend
+pnpm install
+```
+
+Copy `.env.example` to `apps/api/.env` and set `OPENAI_API_KEY`.
+
+## Running
+
+```sh
+# Backend  (http://localhost:8000)
+cd apps/api
+uv run uvicorn app.main:app --reload
+
+# Frontend  (http://localhost:5173)
+pnpm dev
+```
+
+## Tests
+
+```sh
+cd apps/api && uv run pytest -q
+pnpm --filter web test --run
+```
+
+## Cost and caching
+
+Estimated cost is shown before each pipeline stage. Repeated extraction on unchanged sections is served from cache — no new API call is made.
+
+## License
+
+Source-available, personal non-commercial use only. See [LICENSE](LICENSE).

coronelli-0.1.0/README.md

@@ -0,0 +1,90 @@
+# Coronelli ◉
+
+A literary atlas builder — upload a book and explore its world in 3D.
+
+Coronelli is inspired by the craft of historical cartographers: it reads a novel section by section, finds every named place, maps spatial relationships and visual qualities, and builds a navigable world you can orbit and inspect.
+
+```
+Upload → Catalog → Extract → Synthesize → Atlas Editor → 3D Explorer
+```
+
+- Import `.txt`, `.md`, and text-bearing `.pdf` files
+- LLM pipeline identifies places, containment hierarchies, spatial claims, and visual details
+- Every extracted candidate is held for human review before it becomes canonical
+- Edit the atlas — rename entities, merge duplicates, assign hierarchy, add relationships
+- Explore in an interactive 3D scene: zone rings, floating nodes, force-directed layout
+
+## Installation
+
+Requires Python 3.12+. Install with [uv](https://docs.astral.sh/uv/):
+
+```sh
+uv tool install coronelli
+```
+
+Then launch:
+
+```sh
+coronelli
+```
+
+Coronelli opens in your browser at `http://localhost:8000`. Your atlas data is stored locally:
+
+| Platform | Location |
+|----------|----------|
+| Windows  | `%LOCALAPPDATA%\Coronelli\coronelli.db` |
+| macOS    | `~/Library/Application Support/Coronelli/coronelli.db` |
+| Linux    | `~/.local/share/Coronelli/coronelli.db` |
+
+Set your OpenAI API key before running extraction:
+
+```sh
+# in your shell profile, or in %LOCALAPPDATA%\Coronelli\.env  (Windows)
+#                                ~/Library/Application Support/Coronelli/.env  (macOS)
+OPENAI_API_KEY=sk-...
+```
+
+## Requirements (for development)
+
+- Python 3.12+, [uv](https://docs.astral.sh/uv/)
+- Node 20+, pnpm 9+
+- OpenAI API key
+
+## Setup
+
+```sh
+# Backend
+cd apps/api
+uv sync --extra dev
+
+# Frontend
+pnpm install
+```
+
+Copy `.env.example` to `apps/api/.env` and set `OPENAI_API_KEY`.
+
+## Running
+
+```sh
+# Backend  (http://localhost:8000)
+cd apps/api
+uv run uvicorn app.main:app --reload
+
+# Frontend  (http://localhost:5173)
+pnpm dev
+```
+
+## Tests
+
+```sh
+cd apps/api && uv run pytest -q
+pnpm --filter web test --run
+```
+
+## Cost and caching
+
+Estimated cost is shown before each pipeline stage. Repeated extraction on unchanged sections is served from cache — no new API call is made.
+
+## License
+
+Source-available, personal non-commercial use only. See [LICENSE](LICENSE).

coronelli-0.1.0/alembic.ini

@@ -0,0 +1,149 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts.
+# this is typically a path given in POSIX (e.g. forward slashes)
+# format, relative to the token %(here)s which refers to the location of this
+# ini file
+script_location = %(here)s/app/db/migrations
+
+# template used to generate migration file names; The default value is %%(rev)s_%%(slug)s
+# Uncomment the line below if you want the files to be prepended with date and time
+# see https://alembic.sqlalchemy.org/en/latest/tutorial.html#editing-the-ini-file
+# for all available tokens
+# file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s
+# Or organize into date-based subdirectories (requires recursive_version_locations = true)
+# file_template = %%(year)d/%%(month).2d/%%(day).2d_%%(hour).2d%%(minute).2d_%%(second).2d_%%(rev)s_%%(slug)s
+
+# sys.path path, will be prepended to sys.path if present.
+# defaults to the current working directory.  for multiple paths, the path separator
+# is defined by "path_separator" below.
+prepend_sys_path = .
+
+
+# timezone to use when rendering the date within the migration file
+# as well as the filename.
+# If specified, requires the tzdata library which can be installed by adding
+# `alembic[tz]` to the pip requirements.
+# string value is passed to ZoneInfo()
+# leave blank for localtime
+# timezone =
+
+# max length of characters to apply to the "slug" field
+# truncate_slug_length = 40
+
+# set to 'true' to run the environment during
+# the 'revision' command, regardless of autogenerate
+# revision_environment = false
+
+# set to 'true' to allow .pyc and .pyo files without
+# a source .py file to be detected as revisions in the
+# versions/ directory
+# sourceless = false
+
+# version location specification; This defaults
+# to <script_location>/versions.  When using multiple version
+# directories, initial revisions must be specified with --version-path.
+# The path separator used here should be the separator specified by "path_separator"
+# below.
+# version_locations = %(here)s/bar:%(here)s/bat:%(here)s/alembic/versions
+
+# path_separator; This indicates what character is used to split lists of file
+# paths, including version_locations and prepend_sys_path within configparser
+# files such as alembic.ini.
+# The default rendered in new alembic.ini files is "os", which uses os.pathsep
+# to provide os-dependent path splitting.
+#
+# Note that in order to support legacy alembic.ini files, this default does NOT
+# take place if path_separator is not present in alembic.ini.  If this
+# option is omitted entirely, fallback logic is as follows:
+#
+# 1. Parsing of the version_locations option falls back to using the legacy
+#    "version_path_separator" key, which if absent then falls back to the legacy
+#    behavior of splitting on spaces and/or commas.
+# 2. Parsing of the prepend_sys_path option falls back to the legacy
+#    behavior of splitting on spaces, commas, or colons.
+#
+# Valid values for path_separator are:
+#
+# path_separator = :
+# path_separator = ;
+# path_separator = space
+# path_separator = newline
+#
+# Use os.pathsep. Default configuration used for new projects.
+path_separator = os
+
+# set to 'true' to search source files recursively
+# in each "version_locations" directory
+# new in Alembic version 1.10
+# recursive_version_locations = false
+
+# the output encoding used when revision files
+# are written from script.py.mako
+# output_encoding = utf-8
+
+# database URL.  This is consumed by the user-maintained env.py script only.
+# other means of configuring database URLs may be customized within the env.py
+# file.
+sqlalchemy.url = sqlite:///./coronelli.db
+
+
+[post_write_hooks]
+# post_write_hooks defines scripts or Python functions that are run
+# on newly generated revision scripts.  See the documentation for further
+# detail and examples
+
+# format using "black" - use the console_scripts runner, against the "black" entrypoint
+# hooks = black
+# black.type = console_scripts
+# black.entrypoint = black
+# black.options = -l 79 REVISION_SCRIPT_FILENAME
+
+# lint with attempts to fix using "ruff" - use the module runner, against the "ruff" module
+# hooks = ruff
+# ruff.type = module
+# ruff.module = ruff
+# ruff.options = check --fix REVISION_SCRIPT_FILENAME
+
+# Alternatively, use the exec runner to execute a binary found on your PATH
+# hooks = ruff
+# ruff.type = exec
+# ruff.executable = ruff
+# ruff.options = check --fix REVISION_SCRIPT_FILENAME
+
+# Logging configuration.  This is also consumed by the user-maintained
+# env.py script only.
+[loggers]
+keys = root,sqlalchemy,alembic
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = WARNING
+handlers = console
+qualname =
+
+[logger_sqlalchemy]
+level = WARNING
+handlers =
+qualname = sqlalchemy.engine
+
+[logger_alembic]
+level = INFO
+handlers =
+qualname = alembic
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(levelname)-5.5s [%(name)s] %(message)s
+datefmt = %H:%M:%S

coronelli-0.1.0/app/api/admin.py

@@ -0,0 +1,20 @@
+from fastapi import APIRouter, Depends
+from sqlalchemy.orm import Session
+
+from app.db.engine import get_db
+from app.db.models import SourceDocument
+from app.domain.world import EntityMention, MapClaim, MapEntity, MapTravelRule
+
+router = APIRouter(tags=["admin"])
+
+
+@router.delete("/api/admin/reset", status_code=200)
+def reset_library(db: Session = Depends(get_db)) -> dict:
+    """Delete everything: all documents and all derived map data."""
+    db.query(MapClaim).delete(synchronize_session=False)
+    db.query(MapTravelRule).delete(synchronize_session=False)
+    db.query(EntityMention).delete(synchronize_session=False)
+    db.query(MapEntity).delete(synchronize_session=False)
+    db.query(SourceDocument).delete(synchronize_session=False)
+    db.commit()
+    return {"reset": True}

coronelli-0.1.0/app/api/atlas.py

@@ -0,0 +1,15 @@
+from fastapi import APIRouter
+
+from app.api.atlas_edit import router as edit_router
+from app.api.atlas_export import router as export_router
+from app.api.atlas_hierarchy import router as hierarchy_router
+from app.api.atlas_read import router as read_router
+from app.api.atlas_suggestions import router as suggestions_router
+
+router = APIRouter(tags=["atlas"])
+
+router.include_router(read_router)
+router.include_router(export_router)
+router.include_router(edit_router)
+router.include_router(hierarchy_router)
+router.include_router(suggestions_router)