Skip to content

Publishing Guide

This project is set up so it can be published to GitHub and PyPI as brickflowui.

Package identity

  • PyPI package: brickflowui
  • standard import path: brickflowui
  • CLI command:
  • brickflowui
  1. Run tests
python -m pytest -q
  1. If frontend source changed, rebuild assets
cd frontend
npm install
npm run build
cd ..
  1. Build package artifacts
python -m build
  1. Validate artifacts
python -m twine check dist/*
  1. Upload to PyPI
python -m twine upload dist/*

Trusted Publishing with GitHub Actions

This repository includes a GitHub Actions workflow at:

/.github/workflows/publish.yml

When configuring a GitHub trusted publisher on PyPI, use:

  • repository owner: your GitHub username or org
  • repository name: your repository name
  • workflow filename: publish.yml
  • environment: pypi

The workflow is configured to:

  • run tests
  • build the package
  • publish to PyPI with GitHub OIDC trusted publishing

It runs when a GitHub Release is published, and can also be started manually with workflow_dispatch.

Post-publish smoke test

Users should be able to run:

pip install brickflowui

Then:

import brickflowui as db

Packaging notes

  • bundled frontend assets are included in wheel and sdist builds
  • the published distribution includes the brickflowui Python package
  • docs and examples are included in the source distribution