Quantinuum schemas
Public models that define API boundaries used by Quantinuum. Intended to be
used across teams and projects ie. shared. Backwards compatibility and semantic
versioning are particularly important in this repo! The "Check Conventional
Commits format" workflow will make sure your PRs follow a standard
format. For
backwards-incompatible changes, please use the conventional ! or BREAKING CHANGE:.
Dependencies
We try to keep the dependencies minimal. However we do need pydantic for
validation.
Making a release
See notes above about conventional commits and versioning.
Once all your code changes are merged onto the main branch using conventional
commits, follow these steps to publish.
Update the CHANGELOG
-
Update
CHANGELOG.md: this is automated.Use
devenvand thecommitizentool:git fetch --tags origin # make sure your local tags are same as in github cz bump --files-only # --files-only prevents the tool making a git tagThis will use the commit history and modify
CHANGELOG.mdto include a heading with the new version number and the date. The tool automatically decides whether to increment the patch version, minor version or major version.If none of the commits since the last version tag would generate a CHANGELOG entry, then you will see
NO_COMMITS_TO_BUMP. In this situation,>$ # only if you see NO_COMMITS_TO_BUMP... add one to the patch number >$ cz bump --files-only x.y.z+1 # !! substitute correct version >$ vi CHANGELOG.md # edit to explain that there are no changes
-
If you like, you can manually edit
CHANGELOG.mdat this point. Consider moving important entries under these headings, or writing under them (see Keep A Changelog):- Deprecated
- Removed
- Security
-
Create a release branch
git checkout -b release/vx.y.z -
git addthe modifications, thengit commitandgit pushthem. -
Create a PR (title:
docs: Update CHANGELOG for vx.y.z) -
Ask a colleague to review the changes (should be just
CHANGELOG.mdandpyproject.toml) -
Squash merge the PR into
main
Trigger the release workflow
- Go to github.com and on this repo's home page, click "Create a new release"
- Using the version in the format
v1.2.34, click "Choose a tag" and create a new tag - Click "Generate release notes"
- Release title =
v1.2.34. In the "Describe this release" box, copy and paste the new text that was added to CHANGELOG.md in the commit you are releasing. - Click "Publish release".
- The "Create release" workflow should run automatically.
- Check that the new release is on https://pypi.org/project/quantinuum-schemas/#history
License
This project is licensed under Apache License, Version 2.0 (LICENSE or http://www.apache.org/licenses/LICENSE-2.0).
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file quantinuum_schemas-7.8.1.tar.gz.
File metadata
- Download URL: quantinuum_schemas-7.8.1.tar.gz
- Upload date:
- Size: 94.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
uv/0.6.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2a68f0544fcc4d3f65980b0aa8d75f5c99945447adbd501ed8c08ccb2810d5cf
|
|
| MD5 |
9317f9118c38e916c9e75867154b536e
|
|
| BLAKE2b-256 |
077750182a859f42a12c31aac9fa7e6463b399a026871c0fa4ac53cca89b63df
|
File details
Details for the file quantinuum_schemas-7.8.1-py3-none-any.whl.
File metadata
- Download URL: quantinuum_schemas-7.8.1-py3-none-any.whl
- Upload date:
- Size: 27.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
uv/0.6.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
bd65dcc73c887aace08992b42d40ee3f3b5211faf957731a1d80ae2b202e82d9
|
|
| MD5 |
47472384276510d40d69569cf6e68150
|
|
| BLAKE2b-256 |
7431538dc7b7fd380d84b94e84df574ac965d984bfda4802ba15ae3d70f32cf4
|
