Skip to content

Add python bindings #16

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
shsms merged 9 commits into from
Nov 21, 2025
Merged

Add python bindings #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
ecdcadf
Delete the `delete_me` function
shsms Oct 30, 2025
78dc289
Move Python source to `python` dir
shsms Oct 30, 2025
4c1f2b7
Update CI to support building for multiple target platforms
shsms Oct 31, 2025
7b1bfcb
Implement the pyo3 based wrapper for the component graph
shsms Nov 19, 2025
b3b2247
Update build-system to maturin and expose ComponentGraph to python
shsms Nov 19, 2025
3a7b9c1
Add type-hints for the component graph bindings
shsms Nov 19, 2025
4f5087f
Use a newer gh-action-nox that supports running on windows
shsms Nov 19, 2025
a5df901
Update release notes
shsms Nov 19, 2025
d50075d
Update readme
shsms Nov 19, 2025
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
76 changes: 36 additions & 40 deletions .github/workflows/ci.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,30 +28,30 @@ jobs:
strategy:
fail-fast: false
matrix:
arch:
- amd64
- arm
os:
target:
- ubuntu-24.04
- ubuntu-24.04-arm
- windows-latest
- macos-15-intel
- macos-15
python:
- "3.11"
- "3.12"
- "3.13"
- "3.14"
nox-session:
# To speed things up a bit we use the special ci_checks_max session
# that uses the same venv to run multiple linting sessions
- "ci_checks_max"
- "pytest_min"
runs-on: ${{ matrix.os }}${{ matrix.arch != 'amd64' && format('-{0}', matrix.arch) || '' }}
runs-on: ${{ matrix.target }}

steps:
- name: Run nox
uses: frequenz-floss/gh-action-nox@v1.0.1
uses: frequenz-floss/gh-action-nox@e1351cf45e05e85afc1c79ab883e06322892d34c # v1.1.0
with:
python-version: ${{ matrix.python }}
nox-session: ${{ matrix.nox-session }}
# TODO(cookiecutter): Uncomment this for projects with private dependencies
# git-username: ${{ secrets.GIT_USER }}
# git-password: ${{ secrets.GIT_PASS }}

# This job runs if all the `nox` matrix jobs ran and succeeded.
# It is only used to have a single job that we can require in branch
Expand All @@ -72,18 +72,24 @@ jobs:

build:
name: Build distribution packages
# Since this is a pure Python package, we only need to build it once. If it
# had any architecture specific code, we would need to build it for each
# architecture.
runs-on: ubuntu-24.04

strategy:
fail-fast: false
matrix:
target:
- ubuntu-24.04
- ubuntu-24.04-arm
- windows-latest
- macos-15-intel
- macos-15
python:
- "3.11"
- "3.12"
- "3.13"
- "3.14"
runs-on: ${{ matrix.target }}
steps:
- name: Setup Git
uses: frequenz-floss/gh-action-setup-git@v1.0.0
# TODO(cookiecutter): Uncomment this for projects with private dependencies
# with:
# username: ${{ secrets.GIT_USER }}
# password: ${{ secrets.GIT_PASS }}

- name: Fetch sources
uses: actions/checkout@v5
Expand All @@ -93,7 +99,7 @@ jobs:
- name: Setup Python
uses: frequenz-floss/gh-action-setup-python-with-deps@v1.0.1
with:
python-version: ${{ env.DEFAULT_PYTHON_VERSION }}
python-version: ${{ matrix.python }}
dependencies: build

- name: Build the source and binary distribution
Expand All @@ -102,7 +108,7 @@ jobs:
- name: Upload distribution files
uses: actions/upload-artifact@v5
with:
name: dist-packages
name: dist-packages-${{ matrix.target }}-${{ matrix.python }}
path: dist/
if-no-files-found: error

Expand All @@ -112,35 +118,35 @@ jobs:
strategy:
fail-fast: false
matrix:
arch:
- amd64
- arm
os:
target:
- ubuntu-24.04
- ubuntu-24.04-arm
- windows-latest
- macos-15-intel
- macos-15
python:
- "3.11"
- "3.12"
runs-on: ${{ matrix.os }}${{ matrix.arch != 'amd64' && format('-{0}', matrix.arch) || '' }}
- "3.13"
- "3.14"
runs-on: ${{ matrix.target }}

steps:
- name: Setup Git
uses: frequenz-floss/gh-action-setup-git@v1.0.0
# TODO(cookiecutter): Uncomment this for projects with private dependencies
# with:
# username: ${{ secrets.GIT_USER }}
# password: ${{ secrets.GIT_PASS }}

- name: Print environment (debug)
run: env

- name: Download package
uses: actions/download-artifact@v6
with:
name: dist-packages
name: dist-packages-${{ matrix.target }}-${{ matrix.python }}
path: dist

# This is necessary for the `pip` caching in the setup-python action to work
- name: Fetch the pyproject.toml file for this action hash
shell: bash
env:
GH_TOKEN: ${{ github.token }}
REPO: ${{ github.repository }}
Expand Down Expand Up @@ -186,10 +192,6 @@ jobs:
steps:
- name: Setup Git
uses: frequenz-floss/gh-action-setup-git@v1.0.0
# TODO(cookiecutter): Uncomment this for projects with private dependencies
# with:
# username: ${{ secrets.GIT_USER }}
# password: ${{ secrets.GIT_PASS }}

- name: Fetch sources
uses: actions/checkout@v5
Expand Down Expand Up @@ -226,10 +228,6 @@ jobs:
steps:
- name: Setup Git
uses: frequenz-floss/gh-action-setup-git@v1.0.0
# TODO(cookiecutter): Uncomment this for projects with private dependencies
# with:
# username: ${{ secrets.GIT_USER }}
# password: ${{ secrets.GIT_PASS }}

- name: Fetch sources
uses: actions/checkout@v5
Expand Down Expand Up @@ -300,7 +298,6 @@ jobs:
- name: Download distribution files
uses: actions/download-artifact@v6
with:
name: dist-packages
Copy link
Contributor

@llucax llucax Nov 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why removing the name? I guess it will download all artifacts if name is not present, including the generated docs website if it is there?

Copy link
Collaborator Author

@shsms shsms Nov 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, only for the create release and publish stages, because there's a lot of artifacts and we can't use matrix, this was the easy alternative. Both stages will only use the wheel files.

Copy link
Contributor

@llucax llucax Nov 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see. You might be able to use globs, but not sure.

Copy link
Collaborator Author

@shsms shsms Nov 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This wasn't enough, need to build with maturin-action, to build with python's manylinux images: #18 (comment)

I merged it, because it got released as v0.1.0, instead of as rc during my test. Might need improvements, but we can look at it again later when we move this to repo-config

path: dist

- name: Download RELEASE_NOTES.md
Expand Down Expand Up @@ -346,7 +343,6 @@ jobs:
- name: Download distribution files
uses: actions/download-artifact@v6
with:
name: dist-packages
path: dist

- name: Publish the Python distribution to PyPI
Expand Down
Loading