diff --git a/.cz.toml b/.cz.toml index a906b36..441990c 100644 --- a/.cz.toml +++ b/.cz.toml @@ -5,7 +5,7 @@ version_format = "$version" version = "0.0.0" version_files = [ ".cz.toml:version", - "pyproject_qiskit/__init__.py:__version__", + "quantum_enablement/__init__.py:__version__", "test/__init__.py:__version__", "CITATION.bib:version" ] diff --git a/CITATION.bib b/CITATION.bib index c7cba5a..0ee29f3 100644 --- a/CITATION.bib +++ b/CITATION.bib @@ -1,4 +1,4 @@ -@misc{pyproject_qiskit, +@misc{quantum_enablement, author = {Pedro Rivero}, title = {Python Project}, year = {2023}, diff --git a/README.md b/README.md index 8ff21b3..1f5c94e 100644 --- a/README.md +++ b/README.md @@ -4,18 +4,18 @@ ![Platform](https://img.shields.io/badge/Platform-Linux%20%7C%20macOS%20%7C%20Windows-informational) [![Python](https://img.shields.io/badge/Python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11%20%7C%203.12-informational)](https://www.python.org/) [![Qiskit](https://img.shields.io/badge/Qiskit-%E2%89%A5%200.45.1-6133BD)](https://github.com/Qiskit/qiskit)
- [![Tests](https://github.com/pedrorrivero/pyproject-qiskit/actions/workflows/test.yml/badge.svg)](https://github.com/pedrorrivero/pyproject-qiskit/actions/workflows/test.yml) - [![Coverage](https://coveralls.io/repos/github/pedrorrivero/pyproject-qiskit/badge.svg?branch=main)](https://coveralls.io/github/pedrorrivero/pyproject-qiskit?branch=main) - [![Release](https://img.shields.io/github/release/pedrorrivero/pyproject-qiskit.svg?include_prereleases&label=Release)](https://github.com/pedrorrivero/pyproject-qiskit/releases) + [![Tests](https://github.com/IBM-Quantum-Technical-Enablement/quantum-enablement/actions/workflows/test.yml/badge.svg)](https://github.com/IBM-Quantum-Technical-Enablement/quantum-enablement/actions/workflows/test.yml) + [![Coverage](https://coveralls.io/repos/github/IBM-Quantum-Technical-Enablement/quantum-enablement/badge.svg?branch=main)](https://coveralls.io/github/IBM-Quantum-Technical-Enablement/quantum-enablement?branch=main) + [![Release](https://img.shields.io/github/release/IBM-Quantum-Technical-Enablement/quantum-enablement.svg?include_prereleases&label=Release)](https://github.com/IBM-Quantum-Technical-Enablement/quantum-enablement/releases) [![DOI](https://img.shields.io/badge/DOI-zz.nnnn/zenodo.ddddddd-informational)](https://zenodo.org/) - [![License](https://img.shields.io/github/license/pedrorrivero/pyproject-qiskit?label=License)](LICENSE.txt) + [![License](https://img.shields.io/github/license/IBM-Quantum-Technical-Enablement/quantum-enablement?label=License)](LICENSE.txt)

- Logo + Logo

Quantum Enablement

@@ -62,7 +62,7 @@ This team's mission is realized under three main threads: 3. _Workshops and Residency Program_ -- The above content will either be shared broadly through [IBM's Quantum Learning Platform](https://learning.quantum.ibm.com/), workshops, or the _Quantum Residency Program_ for Quantum Computational Centers. -This repository acts as a central _installable library_ for all of the team's assets. See [our issues list](https://github.com/pedrorrivero/pyproject-qiskit/issues) for a proposed list of prototypes and tutorials yet to be made. +This repository acts as a central _installable library_ for all of the team's assets. See [our issues list](https://github.com/IBM-Quantum-Technical-Enablement/quantum-enablement/issues) for a proposed list of prototypes and tutorials yet to be made. @@ -89,19 +89,19 @@ All content will adhere to the following structure: The latest version of this software package can be easily installed, alongside all required dependencies, via `pip`: ``` -pip install pyproject-qiskit +pip install quantum-enablement ``` -For more detailed information and alternative installation options see the [installation guide](https://github.com/pedrorrivero/pyproject-qiskit/blob/main/INSTALL.md). +For more detailed information and alternative installation options see the [installation guide](https://github.com/IBM-Quantum-Technical-Enablement/quantum-enablement/blob/main/INSTALL.md). ## Documentation -- This project includes a quick [reference guide](https://github.com/pedrorrivero/pyproject-qiskit/blob/main/docs/reference_guide.md) to get started with. +- This project includes a quick [reference guide](https://github.com/IBM-Quantum-Technical-Enablement/quantum-enablement/blob/main/docs/reference_guide.md) to get started with. - Complete documentation can be found in the code docstrings. -- Check out the [file map](https://github.com/pedrorrivero/pyproject-qiskit/blob/main/FILEMAP.md) for more information on the structure of this repository. +- Check out the [file map](https://github.com/IBM-Quantum-Technical-Enablement/quantum-enablement/blob/main/FILEMAP.md) for more information on the structure of this repository. @@ -110,7 +110,7 @@ For more detailed information and alternative installation options see the [inst This package is meant to evolve rapidly and, as such, does not follow [Qiskit's deprecation policy](https://github.com/Qiskit/qiskit/blob/main/DEPRECATION.md). -We may occasionally make breaking changes in order to improve the user experience. When possible, we will keep old interfaces and mark them as deprecated, as long as they can co-exist with the new ones. Each substantial improvement, breaking change, or deprecation will be documented in [`CHANGELOG.md`](https://github.com/pedrorrivero/pyproject-qiskit/blob/main/CHANGELOG.md). +We may occasionally make breaking changes in order to improve the user experience. When possible, we will keep old interfaces and mark them as deprecated, as long as they can co-exist with the new ones. Each substantial improvement, breaking change, or deprecation will be documented in [`CHANGELOG.md`](https://github.com/IBM-Quantum-Technical-Enablement/quantum-enablement/blob/main/CHANGELOG.md). Careful version specification is encouraged (e.g. [version pinning](https://www.easypost.com/dependency-pinning-guide)). @@ -119,16 +119,16 @@ Careful version specification is encouraged (e.g. [version pinning](https://www. ## Contributing -- The easiest way to contribute is by [giving feedback](https://github.com/pedrorrivero/pyproject-qiskit/blob/main/CONTRIBUTING.md#giving-feedback). -- If you wish to contribute to the development of the software, you must read and follow our [contribution guidelines](https://github.com/pedrorrivero/pyproject-qiskit/blob/main/CONTRIBUTING.md). -- By participating, you are expected to uphold our [code of conduct](https://github.com/pedrorrivero/pyproject-qiskit/blob/main/CODE_OF_CONDUCT.md). +- The easiest way to contribute is by [giving feedback](https://github.com/IBM-Quantum-Technical-Enablement/quantum-enablement/blob/main/CONTRIBUTING.md#giving-feedback). +- If you wish to contribute to the development of the software, you must read and follow our [contribution guidelines](https://github.com/IBM-Quantum-Technical-Enablement/quantum-enablement/blob/main/CONTRIBUTING.md). +- By participating, you are expected to uphold our [code of conduct](https://github.com/IBM-Quantum-Technical-Enablement/quantum-enablement/blob/main/CODE_OF_CONDUCT.md). ## Authors and Citation -This project is the work of [many people](https://github.com/pedrorrivero/pyproject-qiskit/graphs/contributors) who contribute at different levels. Please cite as per the included [BibTeX file](https://github.com/pedrorrivero/pyproject-qiskit/blob/main/CITATION.bib). +This project is the work of [many people](https://github.com/IBM-Quantum-Technical-Enablement/quantum-enablement/graphs/contributors) who contribute at different levels. Please cite as per the included [BibTeX file](https://github.com/IBM-Quantum-Technical-Enablement/quantum-enablement/blob/main/CITATION.bib). @@ -152,4 +152,4 @@ This project is the work of [many people](https://github.com/pedrorrivero/pyproj ## License -[Apache License 2.0](https://github.com/pedrorrivero/pyproject-qiskit/blob/main/LICENSE.txt) +[Apache License 2.0](https://github.com/IBM-Quantum-Technical-Enablement/quantum-enablement/blob/main/LICENSE.txt) diff --git a/docs/reference_guide.md b/docs/reference_guide.md index f81b54f..bad937e 100644 --- a/docs/reference_guide.md +++ b/docs/reference_guide.md @@ -34,4 +34,4 @@ This guide is for those who just want to use the package. If you want to extend ## Troubleshooting -If you run into problems while using this package, we encourage a careful reading of the error messages first. Efforts have been made to make this messages as descriptive and helpful as possible; nonetheless, if still unable to solve the problem, you are welcome to [open an issue](https://github.com/pedrorrivero/pyproject-qiskit/issues) on the GitHub repository. When doing so, please provide a detailed explanation of what is happening and what needs to be done to reproduce the faulty behavior. +If you run into problems while using this package, we encourage a careful reading of the error messages first. Efforts have been made to make this messages as descriptive and helpful as possible; nonetheless, if still unable to solve the problem, you are welcome to [open an issue](https://github.com/IBM-Quantum-Technical-Enablement/quantum-enablement/issues) on the GitHub repository. When doing so, please provide a detailed explanation of what is happening and what needs to be done to reproduce the faulty behavior. diff --git a/pyproject.toml b/pyproject.toml index e1719b9..28ba719 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,7 +3,7 @@ requires = ["flit_core >=3.2,<4"] build-backend = "flit_core.buildapi" [project] -name = "pyproject-qiskit" +name = "quantum-enablement" authors = [ {name = "Pedro Rivero", email = "pedro.rivero@ibm.com"}, ] @@ -78,12 +78,12 @@ notebook = [ [project.urls] "Home" = "https://qiskit-community.github.io/prototypes/" -"Documentation" = "https://github.com/pedrorrivero/pyproject-qiskit/tree/main/docs/" -"Repository" = "https://github.com/pedrorrivero/pyproject-qiskit/" -"Download" = "https://pypi.org/project/pyproject-qiskit/" +"Documentation" = "https://github.com/IBM-Quantum-Technical-Enablement/quantum-enablement/tree/main/docs/" +"Repository" = "https://github.com/IBM-Quantum-Technical-Enablement/quantum-enablement/" +"Download" = "https://pypi.org/project/quantum-enablement/" [tool.flit.module] -name = "pyproject_qiskit" +name = "quantum_enablement" ############################################################ diff --git a/pyproject_qiskit/__init__.py b/quantum_enablement/__init__.py similarity index 100% rename from pyproject_qiskit/__init__.py rename to quantum_enablement/__init__.py diff --git a/pyproject_qiskit/qiskit/__init__.py b/quantum_enablement/qiskit/__init__.py similarity index 100% rename from pyproject_qiskit/qiskit/__init__.py rename to quantum_enablement/qiskit/__init__.py diff --git a/pyproject_qiskit/utils/__init__.py b/quantum_enablement/utils/__init__.py similarity index 100% rename from pyproject_qiskit/utils/__init__.py rename to quantum_enablement/utils/__init__.py diff --git a/test/__init__.py b/test/__init__.py index 86ae880..f75349b 100644 --- a/test/__init__.py +++ b/test/__init__.py @@ -12,7 +12,7 @@ from collections.abc import Iterable, Sequence -from pyproject_qiskit import __version__ +from quantum_enablement import __version__ def test_version(): diff --git a/tox.ini b/tox.ini index 8081d99..25cff0c 100644 --- a/tox.ini +++ b/tox.ini @@ -35,7 +35,7 @@ basepython = python3.12 setenv = {[testenv]setenv} commands = - pytest --cov pyproject_qiskit + pytest --cov quantum_enablement [testenv:lint] @@ -45,11 +45,11 @@ basepython = python3.12 extras = lint commands = - flake8 pyproject_qiskit test docs - isort pyproject_qiskit test docs --check-only - black pyproject_qiskit test docs --check - pylint -rn pyproject_qiskit - mypy -p pyproject_qiskit + flake8 quantum_enablement test docs + isort quantum_enablement test docs --check-only + black quantum_enablement test docs --check + pylint -rn quantum_enablement + mypy -p quantum_enablement [testenv:style] @@ -59,9 +59,9 @@ basepython = python3.12 extras = lint commands = - autoflake -i --remove-all-unused-imports -r pyproject_qiskit test docs - isort pyproject_qiskit test docs - black pyproject_qiskit test docs + autoflake -i --remove-all-unused-imports -r quantum_enablement test docs + isort quantum_enablement test docs + black quantum_enablement test docs ################################################################################