Skip to content

docs: add pre-pypi install and publish timing guidance#7

Merged
aa-parky merged 1 commit intomainfrom
codex/docs-project-integration-guide
Feb 22, 2026
Merged

docs: add pre-pypi install and publish timing guidance#7
aa-parky merged 1 commit intomainfrom
codex/docs-project-integration-guide

Conversation

@aa-parky
Copy link
Copy Markdown
Contributor

Summary

  • add clear pre-PyPI installation guidance to README
  • include exact GitHub tag install command:
    • pip install "pipeworks-ipc @ git+https://github.com/pipe-works/pipeworks_ipc.git@v0.1.1"
  • document local editable path, Git tag, and commit-SHA install options
  • add pyproject.toml dependency examples for consumers before PyPI
  • add explicit "when to publish to PyPI" decision criteria and rollout steps
  • mirror this guidance in Sphinx docs (usage.rst and project_integration.rst)

Validation

  • make -C docs clean html
  • pre-commit run --files README.md docs/source/usage.rst docs/source/project_integration.rst

@aa-parky aa-parky force-pushed the codex/docs-project-integration-guide branch from 9dda991 to 7917140 Compare February 22, 2026 12:19
@codecov
Copy link
Copy Markdown

codecov bot commented Feb 22, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@aa-parky aa-parky merged commit 4f65b7c into main Feb 22, 2026
13 checks passed
@aa-parky aa-parky deleted the codex/docs-project-integration-guide branch February 22, 2026 12:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant