# Q-CTRL Release Noter
The Q-CTRL Release Noter Python package provides a command line tool that generates the recommended release notes for a GitHub package from Q-CTRL.
## Installation
Install the Q-CTRL Release Noter with:
```shell
pip install qctrl-release-noter
```
## Usage
In the repository whose release notes you want to generate, run:
```shell
release_noter
```
You can also specify the path of the repository:
```shell
release_noter /path/to/repository
```
To prefill the information on the GitHub release page, use:
```shell
release_noter --github
```
Raw data
{
"_id": null,
"home_page": "https://q-ctrl.com",
"name": "qctrl-release-noter",
"maintainer": "Q-CTRL",
"docs_url": null,
"requires_python": "<3.13,>=3.9",
"maintainer_email": "support@q-ctrl.com",
"keywords": "black opal, boulder opal, fire opal, nisq, open controls, q control, q ctrl, q-control, q-ctrl, qcontrol, qctrl, quantum, quantum algorithms, quantum circuits, quantum coding, quantum coding software, quantum computing, quantum control, quantum control software, quantum control theory, quantum engineering, quantum error correction, quantum firmware, quantum fundamentals, quantum sensing, qubit, qudit",
"author": "Q-CTRL",
"author_email": "support@q-ctrl.com",
"download_url": "https://files.pythonhosted.org/packages/69/be/90ef426a545fc6eb260d17fe4c4d3d8a81ea74e0d7d3dfa0c7498a42e212/qctrl_release_noter-0.13.0.tar.gz",
"platform": null,
"description": "# Q-CTRL Release Noter\n\nThe Q-CTRL Release Noter Python package provides a command line tool that generates the recommended release notes for a GitHub package from Q-CTRL.\n\n## Installation\n\nInstall the Q-CTRL Release Noter with:\n\n```shell\npip install qctrl-release-noter\n```\n\n## Usage\n\nIn the repository whose release notes you want to generate, run:\n\n```shell\nrelease_noter\n```\n\nYou can also specify the path of the repository:\n\n```shell\nrelease_noter /path/to/repository\n```\n\nTo prefill the information on the GitHub release page, use:\n\n```shell\nrelease_noter --github\n```\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Q-CTRL Release Noter",
"version": "0.13.0",
"project_urls": {
"Facebook": "https://www.facebook.com/qctrl",
"GitHub": "https://github.com/qctrl",
"Homepage": "https://q-ctrl.com",
"LinkedIn": "https://www.linkedin.com/company/q-ctrl/",
"Twitter": "https://twitter.com/qctrlHQ",
"YouTube": "https://www.youtube.com/qctrl"
},
"split_keywords": [
"black opal",
" boulder opal",
" fire opal",
" nisq",
" open controls",
" q control",
" q ctrl",
" q-control",
" q-ctrl",
" qcontrol",
" qctrl",
" quantum",
" quantum algorithms",
" quantum circuits",
" quantum coding",
" quantum coding software",
" quantum computing",
" quantum control",
" quantum control software",
" quantum control theory",
" quantum engineering",
" quantum error correction",
" quantum firmware",
" quantum fundamentals",
" quantum sensing",
" qubit",
" qudit"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "935aed4b56c3b65ee67f45cf8ff6d604c44972bfd9149abfc75bf6ab83f68ec7",
"md5": "59f8e18e132e253792a97ffd1f423025",
"sha256": "0b32ab1ac9f6d07b5e6ab3eb55560c61131c4293a10450c9242e0da2724bbad2"
},
"downloads": -1,
"filename": "qctrl_release_noter-0.13.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "59f8e18e132e253792a97ffd1f423025",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.9",
"size": 13218,
"upload_time": "2024-06-04T06:17:07",
"upload_time_iso_8601": "2024-06-04T06:17:07.280703Z",
"url": "https://files.pythonhosted.org/packages/93/5a/ed4b56c3b65ee67f45cf8ff6d604c44972bfd9149abfc75bf6ab83f68ec7/qctrl_release_noter-0.13.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "69be90ef426a545fc6eb260d17fe4c4d3d8a81ea74e0d7d3dfa0c7498a42e212",
"md5": "6f9e15fa4c08d9acbed17cc8658552f9",
"sha256": "dcd942e0fdf9187d9cbd6070792392f85c09c4224f814776206dab2bd7445bc0"
},
"downloads": -1,
"filename": "qctrl_release_noter-0.13.0.tar.gz",
"has_sig": false,
"md5_digest": "6f9e15fa4c08d9acbed17cc8658552f9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.9",
"size": 11214,
"upload_time": "2024-06-04T06:17:09",
"upload_time_iso_8601": "2024-06-04T06:17:09.303494Z",
"url": "https://files.pythonhosted.org/packages/69/be/90ef426a545fc6eb260d17fe4c4d3d8a81ea74e0d7d3dfa0c7498a42e212/qctrl_release_noter-0.13.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-04 06:17:09",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "qctrl-release-noter"
}