Metadata-Version: 2.1
Name: qctrl-release-noter
Version: 0.13.0
Summary: Q-CTRL Release Noter
Home-page: https://q-ctrl.com
License: Apache-2.0
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
Maintainer: Q-CTRL
Maintainer-email: support@q-ctrl.com
Requires-Python: >=3.9,<3.13
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Topic :: Software Development :: Embedded Systems
Classifier: Topic :: System :: Distributed Computing
Requires-Dist: click (>=8.0,<9.0)
Requires-Dist: gitpython (>=3.1.37,<4.0.0)
Requires-Dist: packaging (>=24.0,<25.0)
Requires-Dist: pyinflect (>=0.5.1,<0.6.0)
Project-URL: Facebook, https://www.facebook.com/qctrl
Project-URL: GitHub, https://github.com/qctrl
Project-URL: LinkedIn, https://www.linkedin.com/company/q-ctrl/
Project-URL: Twitter, https://twitter.com/qctrlHQ
Project-URL: YouTube, https://www.youtube.com/qctrl
Description-Content-Type: text/markdown

# 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
```

