Skip to content

Docs: make the PyPI path the primary v0.5.0 quickstart #157

Description

@ajdelaguila

Evidence

The maintainer review in aristoapp/awesome-second-brain#31 accepted Data Olympus as eligible for a full core profile while identifying Python 3.13 and uv as material setup burden. The package is now published on PyPI at v0.5.0, but our public entry points do not reflect the shipped distribution:

  • README.md still reports v0.4.1 and leads with an editable source install.
  • docs/quickstart.md still says Trusted Publishing is pending and that the PyPI commands will fail.
  • The quickstart's server path depends on ./scripts/run-local.sh, which is unavailable to a PyPI-only user.

Sources:

User problem

A new evaluator sees a source-development workflow instead of the shortest supported installation path. That overstates setup friction, exposes stale release information, and makes it unclear how a PyPI-only user starts the MCP server against a new bundle.

Current behavior

PyPI and data-olympus setup are shipped, but the top-level quickstart and detailed quickstart still describe the pre-publication state.

Expected change

  • Update the README release line to the current release.
  • Make uvx or uv tool install the primary user installation path.
  • Keep editable source installation clearly labeled as the contributor and development path.
  • Remove the obsolete Trusted Publishing warning.
  • Document a complete PyPI-only path from package installation through bundle initialization, git initialization, server launch, readiness verification, and guided agent setup.
  • Verify every documented command from a clean temporary environment.
  • Avoid implying that Python 3.13 and uv no longer represent setup cost.

Acceptance criteria

  • A clean machine with Python 3.13 and uv can follow the primary quickstart without cloning the repository.
  • The installed-package path includes an executable MCP server launch command and a readiness check.
  • README.md, docs/quickstart.md, and release references agree on the supported distribution and current release.
  • Source installation remains documented for contributors.
  • Documentation tests or a CI smoke check protect the packaged quickstart from drifting again.

Non-goals

  • Removing the Python 3.13 or uv requirement.
  • Adding a hosted service or standalone native binary.
  • Changing server architecture.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationpriority: highHigh priority; pull from the queue ASAP

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions