Repository navigation
docs(readme): rewrite the top-level README for the v0.3.0 release (ITL-1180) - #412
Merged
eywalker merged 3 commits intoNov 17, 2026
Merged
Conversation
…L-1180) Say what Orcapod is, give installation for 0.3.0 with every extra, a quick example run by the doc sample test (a job, then a re-run that computes only the new row), links that work on PyPI, a short status section and a short development section. Move the internal "Lower-level details on pipeline workflow (tentative)" notes unchanged to docs/dev/notes/, and drop the stale "0.2.0 is not on PyPI" sentence from docs/index.md too. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
ITL-1180 Rewrite the top-level README for the v0.3.0 public release
Overview
Goals & Success Criteria
Scope & BoundariesIn scope:
Out of scope:
Dependencies & Risks
|
…and link the upgrade notes (ITL-1180) Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…rite-the-top-level-readme-for-the-v030 # Conflicts: # README.md # docs/index.md
eywalker
deleted the
eywalker/itl-1180-rewrite-the-top-level-readme-for-the-v030
branch
November 17, 2026 02:56
eywalker
pushed a commit
that referenced
this pull request
Nov 17, 2026
…al tags slice (ITL-1023) Clean merge: README rewrite (#412), changelog fold (#329), v0.3.0 date and golden release record (#413). Data context v1 is frozen as release 0.3.0; the golden folder and src/orcapod/contexts are byte-identical to main. The slice's changelog fragments (ITL-1017, ITL-1019, ITL-1022, ITL-1023) stay fragments for the next release. Refs ITL-1023 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes ITL-1180
Rewrites
README.md(the first page of the public repository and the PyPI description) for the v0.3.0 release: 278 lines down to 160.New README: sections
pip install orcapod/uv add orcapod, Python 3.11 to 3.13, a table of every extra inpyproject.toml(ray,redis,postgresql,spiraldb,torch(new in the table),all), the optional Graphvizdotbinary. The "0.2.0 is not on PyPI, latest is 0.1.4" sentence is replaced by the release PR's note: 0.3.0 is the first PyPI release since 0.1.4, 0.2.0 was never on PyPI, with a link to "Upgrading from 0.2.0".DictSource, one function pod, aPipelineJobon anInMemoryArrowDatabase; the first run computes 2 rows, then a new job over the same database with one added row computes 1 and reads 2 from the store. Both blocks run intests/test_docs/test_doc_samples.py, every printed line shown.https://github.com/nauticalab/orcapod-python/...links, so they work on PyPI; no link to a hosted docs site.ProvisionalHashWarning); stores from 0.1.x / 0.2.0 / 0.3 development builds not read as current (link to "Upgrading from 0.2.0" in the CHANGELOG); connector databases refuse function nodes.orcapod-extension-spikeinterface(unchanged).uv sync, the four required CI commands, PostgreSQL tests in one sentence with a link to their workflow, releasing with a link toRELEASING.md.Every factual claim and what backs it
docs/index.md,docs/getting-started.md("Creating a source"),docs/concepts/streams.mddocs/getting-started.md,docs/concepts/operators.md, CLAUDE.md operator/function pod boundarydocs/concepts/pipeline-job.md(first paragraph)docs/concepts/sources.md"How sources add provenance columns" (system tags,_source_columns)orcapodpyproject.toml(requires-python, classifiers,name)ray→RayExecutor;redis→RedisCacher;postgresql→ connector, table source, file hash cache;spiraldb→ connector and table source;torch→ PyTorch, any installed torch works;allpyproject.toml[project.optional-dependencies]and its torch comment;src/orcapod/hashing/string_cachers.py;docs/concepts/sources.md;docs/concepts/file-hash-caching.mdCHANGELOG.md"Upgrading from 0.2.0"dotoptional, only for rendering graphsdocs/index.md, CLAUDE.mdtests/test_docs/test_doc_samples.pydocs/concepts/pipeline-job.md"What a re-run computes"InMemoryArrowDatabaselives for the process;DeltaTableDatabasewrites to disk, found again in a new sessiondocs/concepts/pipeline-job.md"The database"docs/tutorial/00–10,docs/index.mddocs/reference/golden-hashes.md,CHANGELOG.md0.3.0 (ITL-946)ProvisionalHashWarningonce per type per processdocs/concepts/arrays.md("will be reviewed for v0.4 and may change then"),CHANGELOG.md0.3.0 (ITL-1068)CHANGELOG.md0.3.0 (ITL-944, ITL-954, ITL-1154)CHANGELOG.md0.3.0 (ITL-1154)CHANGELOG.md0.3.0 Known limitations (ITL-1162),docs/concepts/pipeline-job.md"Connector databases"--postgres;PG*variablestests/conftest.py,.github/workflows/run-postgres-tests.yml(the old README's command lacked--postgresand so skipped every test)RELEASING.mdpyproject.toml,LICENSENote on the
#upgrading-from-020linkThe README links
CHANGELOG.md#upgrading-from-020twice. That heading (#### Upgrading from 0.2.0, under 0.3.0's "Breaking changes and migration") came with the release PR (#329), now onmainand merged into this branch; the anchor resolves.Other changes
docs/dev/notes/pipeline-workflow-notes.md: the README section "Lower-level details on pipeline workflow (tentative)" moved here, text unchanged (a short preface added).docs/dev/orcapod-design.mdand the concept pages do not cover it (observer contextualization,DataLogger,CapturedLogs, the Ray capture path)..gitignore:!docs/dev/notes, sincedocs/dev/*is ignored except its listed subfolders.changelog.d/README.md).Checks
uv run pytest tests/test_docs: 69 passed (README samples,mkdocs build --strict).uv build: the sdist containsREADME.md;uvx twine check: PASSED for sdist and wheel.ruff check,ruff format --check: clean. Whole-treebasedpyright: exit 0.scripts/design_issues.py --check,scripts/assemble_changelog.py --check: OK.git grep README tests/ scripts/).🤖 Generated with Claude Code