microsoft / microsoft/qdk

Update version handling in Python packages

Open
#1,983 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

help wanted low-priority
Dominant language
Rust
Stars
1k
Forks
212
Avg merge
3d 8h
Merged PRs (30d)
65

Description

Dynamically set __version__ on Python packages and replace the current version string used in Python telemetry based on pyproject.toml (e.g. see https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html#dynamic-metadata ).

We should use a consistent approach for the `qsharp` and `qsharp-widgets` packages.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the pyproject.toml files for the qsharp and qsharp-widgets packages, then trace how each package currently sets __version__ and the version used in Python telemetry. Use the setuptools dynamic metadata guidance linked in the issue to define one consistent approach, and verify both packages expose the configured version and use it for telemetry.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
66/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.