This guide takes you from the zip file to pip install pybi-ray working for everyone, with the repository open for contributors. Follow the parts in order. Commands are for Windows (Command Prompt / PowerShell); they work the same on macOS/Linux.
| Name | Value |
|---|---|
| GitHub repo | rafay183/pybi |
| PyPI package (install name) | pybi-ray |
| Command users type | pybi |
| Python import | import pybi |
| First version | 0.1.0 (tag v0.1.0) |
pybi-ray. You will add a fresh one in Part 3.0.1.0 file already exists there, change the version to 0.1.1 in Part 1 step 4.pybi folder (e.g. C:\Users\M Rafay Shaikh\OneDrive\Desktop\pybi).Tip: keep code outside OneDrive (e.g.
C:\dev\pybi). OneDrive syncing can lock files that Git is writing.
pybi-ray-0.1.0-source.zip to C:\dev\ → you get C:\dev\pybi.C:\dev\pybi\.github\workflows\ contains ci.yml and publish.yml. (These hidden files are what make GitHub publish for you.)Open a terminal in the folder:
cd C:\dev\pybi
python -m venv .venv
.venv\Scripts\activate
pip install -e ".[dev]"
pytest -q
pybi demo
You should see 31 passed and the demo dashboard in your browser. Press Ctrl+C in the terminal to stop it.
pyproject.toml → version = "0.1.0" and name = "pybi-ray"src/pybi/__init__.py → __version__ = "0.1.0"Open-source Power BI alternative in Python — dashboards, DAX-style measures, 214 connectorsPush the code (first time only — set your Git identity if you haven’t):
git config --global user.name "Muhammad Rafay Shaikh"
git config --global user.email "<the email on your GitHub account>"
git init
git add .
git commit -m "PyBI 0.1.0 - initial release"
git branch -M main
git remote add origin https://github.com/rafay183/pybi.git
git push -u origin main
If Git asks you to sign in, a browser window opens — sign in to GitHub there.
Fill in exactly:
| Field | Value |
|---|---|
| PyPI Project Name (pending only) | pybi-ray |
| Owner | rafay183 |
| Repository name | pybi |
| Workflow name | publish.yml |
| Environment name | pypi |
pypi → Configure environment → tick Required reviewers → add yourself → Save protection rules. Now every release waits for your approval click, so nobody can publish by accident.Publishing happens only when you push a version tag. Pushing to main runs tests but never publishes.
git tag v0.1.0
git push origin v0.1.0
You should see * [new tag] v0.1.0 -> v0.1.0.
Then open https://github.com/rafay183/pybi/actions → click the run named v0.1.0. It runs four jobs:
test → build → publish → github-release
build also checks that the tag (v0.1.0) matches the version in pyproject.toml; if not, it stops with a clear error.github-release automatically creates a GitHub Release with the wheel attached and notes generated from your commits.In a new terminal (not the dev venv):
pip install pybi-ray
pybi version
pybi demo
pybi version prints PyBI 0.1.0 and the dashboard opens. 🎉
https://pypi.org/project/pybi-ray/; topics:
power-bi business-intelligence dashboard data-visualization dax analytics python pandas open-sourcegood first issue and help wanted (if missing) and connector.connector, good first issueenhancement, help wantedgood first issuemain: Settings → Branches → Add branch ruleset (or Add rule) → target main → tick Require a pull request before merging and Require status checks to pass → choose the CI checks → Create. Contributors then work through pull requests that are tested automatically.Contributors read CONTRIBUTING.md (setup, structure, how to add connectors/visuals/DAX functions); issue and PR forms are already in .github/.
main.0.1.1:
pyproject.toml → version = "0.1.1"src/pybi/__init__.py → __version__ = "0.1.1"CHANGELOG.md, rename Unreleased items into a new ## [0.1.1] - YYYY-MM-DD section.Commit, push, tag:
git add .
git commit -m "Release 0.1.1"
git push
git tag v0.1.1
git push origin v0.1.1
Version rules (semantic versioning): 0.1.1 = bug fixes · 0.2.0 = new features · 1.0.0 = stable, big promise.
pypi-) — it is shown only once.In the project folder:
pip install build twine
rmdir /s /q dist # Windows: remove old builds (macOS/Linux: rm -rf dist)
python -m build
twine check dist/*
twine upload dist/*
__token__ · Password: paste the token (nothing shows while pasting — that’s normal).| Symptom | Cause → Fix |
|---|---|
pip install pybi-ray → from versions: none |
Nothing published yet → push the tag (Part 4) or use Plan B. Wait 1–2 min after publishing. |
git push origin v0.1.0 → Everything up-to-date, no run appears |
The tag is already on GitHub but the workflow file isn’t → check .github/workflows/publish.yml exists on GitHub, then re-create the tag:git tag -d v0.1.0git push origin :refs/tags/v0.1.0git tag v0.1.0git push origin v0.1.0 |
error: src refspec v0.1.0 does not match any |
Tag not created yet → git tag v0.1.0 first. |
| Run stuck on Queued for 10+ minutes | GitHub runner problem → check https://www.githubstatus.com, cancel and Re-run all jobs, or use Plan B. |
publish job: invalid-publisher |
Part 3 values don’t match exactly (owner, repo, publish.yml, pypi). |
publish job: File already exists |
That version was uploaded before — PyPI never allows reuse → bump the version and tag again. |
build job: Tag vX does not match pyproject version |
Update pyproject.toml version (and __init__.py), commit, re-create the tag. |
test job fails |
Click the red job, read the error, fix, push, re-create the tag. |
git push asks for a password |
GitHub doesn’t accept passwords → sign in via the browser window, or use a Personal Access Token as the password. |
remote origin already exists |
git remote set-url origin https://github.com/rafay183/pybi.git |