MAINT: Create CircleCI job to test against wheels (binary distributions) by mberz · Pull Request #310 · pyfar/spharpy

mberz · 2026-03-30T15:52:03Z

Which issue(s) are closed by this pull request?

Closes #309

Changes proposed in this pull request:

Add test against the binary distribution (wheels) to the CircleCI pipeline
Also re-organized the test pipeline a bit. Built products are now stored in the workspace and passed between runners to avoid duplicate steps.
Removed commented out installation of system dependencies.

Note: tests are expected to fail, since this PR helps to detect issues such as reported in #308, see #309 for further info.

…are already passing

Copilot

Pull request overview

Updates the CircleCI pipeline to add test coverage for installed wheel distributions and to reuse built dist/ artifacts across subsequent jobs via the workspace, helping detect packaging issues like missing non-Python files.

Changes:

Added a build_distribution job that builds sdist/wheel artifacts and persists dist/ to the workspace.
Added a test_wheel job that installs the built wheel into an isolated venv and runs the test suite against the installed distribution.
Rewired publish/check jobs and workflow dependencies to consume dist/ from the workspace; removed commented-out system dependency install steps.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

.circleci/config.yml

ahms5

I love it. I wonder if we really need to test_source, as test_wheel should also fail in case test_source fails.

ahms5 · 2026-03-31T15:18:11Z

.circleci/config.yml

+          at: /tmp/workspace
      - run:
          name: install dependencies
          command: pip install ".[deploy]"


Suggested change

command: pip install ".[deploy]"

command: pip install twine

woudnt this be sufficiant?

In theory yes, but I'd like to avoid managing dependencies in the CircleCI config and the pyproject.toml. This way it's always sufficient to extend and update in a single place.

I see your point. My thinking here is that this job is only invoking twine, which doesn’t depend on our project’s dependencies or anything that could vary with the package—it’s just a standalone tool.
We could compare it to ruff, but in that case we pin a specific version and install it via the project configuration. Imo this makes sence here, but we dont have this requriedment for twine.
If we want to change the dependency of twine we also need to change this workflow here.
Right now, installing all packages takes about 29 seconds in CI. Installing only twine should be significantly faster. This also scales better, since this job will run for every package on each pull request.

Sorry, I still don't really get the point. You could also pin to a specific version within the CircleCI config. My point is more about central management of dependencies in the toml, instead of individual management of dependencies in different places.

I realized though, that its probably more useful to check the binary distribution within the built job instead of creating a new job. This probably saves more time than the 29 secs you mentioned.

To be honest, I think this job can be removed altogether.
It only checks if the meta-data provided in the pyproject.toml is according to what PyPI expects. More specifically, it only checks the content of the item long_description.
I think it's sufficient to check this before truly releasing a new version and remove the check in PRs, etc.

https://twine.readthedocs.io/en/stable/internal/twine.commands.check.html#twine.commands.check.check

that would also work for me

ahms5 · 2026-03-31T15:18:40Z

.circleci/config.yml

@@ -150,18 +190,17 @@ jobs:
          command: pip install ".[deploy]"


Suggested change

command: pip install ".[deploy]"

command: pip install twine

same here.

see comment above

ahms5 · 2026-03-31T15:21:42Z

.circleci/config.yml

+          name: Install wheel in isolated venv and run tests
+          command: |
+            python -m venv .wheeltest
+            WHEEL=$(ls -1 /tmp/workspace/dist/*.whl | head -n 1)
+            .wheeltest/bin/python -m pip install "${WHEEL}[tests]"
+            TEST_PYTHON="$(pwd)/.wheeltest/bin/python"
+            rm -rf /tmp/spharpy-wheel-tests
+            mkdir -p /tmp/spharpy-wheel-tests
+            cp -r tests /tmp/spharpy-wheel-tests/
+            cd /tmp/spharpy-wheel-tests
+            "$TEST_PYTHON" -m pytest tests
+


this is not that easy to read, maybe we can spit this into 3 blocks, sth like create environment, move files, and test. In this way the maintainance would be easier.

I think it's plenty easy to read 💩

... I'll update :)

mberz · 2026-03-31T15:29:23Z

I love it. I wonder if we really need to test_source, as test_wheel should also fail in case test_source fails.

In general I agree, my first draft of this did exactly that.
In the end I extended to both so that it's easier to spot where issues are coming from. But you're right, in probably 95% of the cases there's not really a difference. It's more the 5% might be harder to figure out why they actually fail.

ahms5 · 2026-04-01T06:43:18Z

.circleci/config.yml

+          at: /tmp/workspace
      - run:
          name: install dependencies
          command: pip install ".[deploy]"


I see your point. My thinking here is that this job is only invoking twine, which doesn’t depend on our project’s dependencies or anything that could vary with the package—it’s just a standalone tool.
We could compare it to ruff, but in that case we pin a specific version and install it via the project configuration. Imo this makes sence here, but we dont have this requriedment for twine.
If we want to change the dependency of twine we also need to change this workflow here.
Right now, installing all packages takes about 29 seconds in CI. Installing only twine should be significantly faster. This also scales better, since this job will run for every package on each pull request.

ahms5 · 2026-04-01T06:43:53Z

.circleci/config.yml

      - run:
          name: Install System Dependencies
          command: sudo apt-get update && sudo apt-get install -y libsndfile1


Suggested change

- run:

name: Install System Dependencies

command: sudo apt-get update && sudo apt-get install -y libsndfile1

I think this is nor required here, isnt it?

ahms5 · 2026-04-01T06:50:46Z

.circleci/config.yml

+            - test_source
+
+      - test_wheel:
+          matrix:


to reduce redandency we could also jsut run test_wheel on main and develop and not for each pull in a pr

I'll update that at the end, to make sure it still triggers as long as work on this PR is ongoing

…elease tags

Create CircleCI job to test against wheels (binary distributions)

2a329f5

mberz added the ci label Mar 30, 2026

mberz added this to Weekly Planning Mar 30, 2026

github-project-automation bot moved this to Backlog in Weekly Planning Mar 30, 2026

mberz moved this from Backlog to Implementation in progress in Weekly Planning Mar 30, 2026

mberz mentioned this pull request Mar 30, 2026

[HOT] Add samplings to wheel #307

Open

mberz added this to the v1.0.1 milestone Mar 30, 2026

mberz changed the title ~~Create CircleCI job to test against wheels (binary distributions)~~ MAINT: Create CircleCI job to test against wheels (binary distributions) Mar 30, 2026

mberz added 8 commits March 30, 2026 18:06

Update requirements for wheel testing

90eb203

rename build_and_test to test_source

1027bf8

remove waiting for source tests

40dc5a0

add missing dependencies for tests to the fresh environment

922d72b

Add missing test folder

1d271d6

create test folder for wheel tests

b02fb45

Update paths

d0f1d91

re-write the circleci config to re-use built dists from the build job

0c87fea

mberz mentioned this pull request Mar 30, 2026

CI: Re-write the circleci config to re-use built dists from the build job #311

Merged

mberz added 3 commits March 30, 2026 19:04

Run tests against binary distributions only of tests against sources …

60fdb50

…are already passing

remove commented out instructions

e3ce397

fix indent issue in config

f0d4265

mberz requested review from a team, ahms5, Copilot, f-brinkmann, hoyer-a, sikersten and tluebeck March 30, 2026 17:18

Copilot started reviewing on behalf of mberz March 30, 2026 17:19 View session

Copilot AI reviewed Mar 30, 2026

View reviewed changes

.circleci/config.yml Outdated Show resolved Hide resolved

.circleci/config.yml Show resolved Hide resolved

mberz force-pushed the ci/test_wheels branch from 34aaef2 to f0d4265 Compare March 30, 2026 17:38

mberz moved this from Implementation in progress to Require review in Weekly Planning Mar 30, 2026

ahms5 requested changes Mar 31, 2026

View reviewed changes

ahms5 reviewed Apr 1, 2026

View reviewed changes

h-chmeruk mentioned this pull request Apr 1, 2026

Add .circleci/ folder to the template pyfar/template-pyfar-package#40

Merged

ahms5 mentioned this pull request Apr 1, 2026

latest changes on ci pipeline pyfar/template-pyfar-package#45

Open

mberz added 5 commits April 2, 2026 11:45

Split up steps for testing of wheels and add description to the job.

5236d10

remove unncessary system dependency installation

58fefee

Restructure

2431b49

use fixed path for wheeltest venv in the systems temporary directory

86c62a5

run test_pypi_publish job only on the main and develop branches and r…

65e5d3f

…elease tags

	- run:
	name: Install System Dependencies
	command: sudo apt-get update && sudo apt-get install -y libsndfile1

Conversation

mberz commented Mar 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Which issue(s) are closed by this pull request?

Changes proposed in this pull request:

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

ahms5 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mberz commented Mar 31, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

mberz commented Mar 30, 2026 •

edited

Loading