Skip to content

Publishing to PyPI

Maintainer checklist for releasing hiveflow-core and hiveflow-agent.

Note: PyPI name hiveflow is owned by another project (py-HiveFlow). Our core package publishes as hiveflow-core; Python import remains import hiveflow.

Prerequisites

  1. PyPI account; names hiveflow-core (available) and hiveflow-agent (available)
  2. GitHub secret PYPI_API_TOKEN with upload scope
  3. All CI jobs green on main

Release steps

# 1. Update version in packages/core/pyproject.toml and packages/agent/pyproject.toml
# 2. Update CHANGELOG.md [Unreleased] section
git add -A && git commit -m "chore: release v0.1.0"
git tag v0.1.0
git push origin main --tags

See Release workflow and Docs workflow.

Release notes are drafted via release-drafter.yml.

Verify install

python -m venv /tmp/hf-verify
source /tmp/hf-verify/bin/activate  # Windows: Scripts\activate
pip install hiveflow-core hiveflow-agent
python -c "import hiveflow; print(hiveflow.__name__)"
python examples/01_hello_hiveflow.py

GitHub Pages (docs)

Docs deploy automatically on push to main via the Docs workflow.

Enable in repo Settings → Pages → Build and deployment → GitHub Actions.

Site URL: https://<org>.github.io/hiveflow/

Enable Discussions

Repo Settings → General → Features → Discussions — use for Q&A and show-and-tell (issues stay for bugs/features).

Release Drafter

Merged PRs update the draft release notes via release-drafter. Copy relevant sections into CHANGELOG.md before tagging.