Skip to content

Claude/prepare pypi release vqq zs #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TheAmericanMaker merged 2 commits into from
Apr 5, 2026
Merged

Claude/prepare pypi release vqq zs #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
04686cf
Prepare for first PyPI release
claude Apr 5, 2026
9a28d8a
Update README source install section to remove pre-release framing
claude Apr 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,6 @@ On macOS or Linux, replace `py -3` with `python3` in the commands below.

### From PyPI

After the first public PyPI release:

```bash
py -3 -m pip install broadside-ai
```
Expand All @@ -67,7 +65,7 @@ py -3 -m pip install "broadside-ai[all]"

### From a downloaded ZIP or cloned repo

This works now, even before the PyPI package is published.
If you prefer to install from source:

Windows PowerShell, if you downloaded the GitHub ZIP:

Expand Down
25 changes: 21 additions & 4 deletions RELEASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,27 @@ Use this checklist when publishing Broadside-AI.
4. Add `pypi` and `testpypi` environments in GitHub with the protections you want.
5. Confirm the publish workflows can request `id-token: write`.

For PyPI Trusted Publishing, the workflow file paths in this repo are:

- `.github/workflows/publish.yml` for PyPI
- `.github/workflows/publish-testpypi.yml` for TestPyPI
### Trusted publisher values

**PyPI** (create as pending publisher at <https://pypi.org/manage/account/publishing/>):

| Field | Value |
| ----------------- | -------------------------------------- |
| Project name | `broadside-ai` |
| Owner | `HuginnIndustries` |
| Repository name | `Broadside-AI` |
| Workflow name | `publish.yml` |
| Environment name | `pypi` |

**TestPyPI** (create at <https://test.pypi.org/manage/account/publishing/>):

| Field | Value |
| ----------------- | -------------------------------------- |
| Project name | `broadside-ai` |
| Owner | `HuginnIndustries` |
| Repository name | `Broadside-AI` |
| Workflow name | `publish-testpypi.yml` |
| Environment name | `testpypi` |

## Local release gate

Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ openai = ["openai>=1.50.0"]
all = ["anthropic>=0.40.0", "openai>=1.50.0"]
dev = [
"build>=1.2.2",
"packaging>=24.2",
"pytest>=8.0.0",
"pytest-asyncio>=0.24.0",
"ruff>=0.8.0",
Expand Down
Loading