Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update package title and links #2

Merged
merged 1 commit into from
Jan 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .cz.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
]
Expand Down
2 changes: 1 addition & 1 deletion CITATION.bib
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
@misc{pyproject_qiskit,
@misc{quantum_enablement,
author = {Pedro Rivero},
title = {Python Project},
year = {2023},
Expand Down
32 changes: 16 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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) <br />
[![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)

</div> <br />

<!-- PROJECT LOGO AND TITLE -->
<p align="center">
<a href="README.md">
<img src="https://github.com/pedrorrivero/pyproject-qiskit/blob/main/docs/media/cover.png?raw=true" alt="Logo" width="300">
<img src="https://github.com/IBM-Quantum-Technical-Enablement/quantum-enablement/blob/main/docs/media/cover.png?raw=true" alt="Logo" width="300">
</a>
<h1 align="center">Quantum Enablement</h1>
</p>
Expand Down Expand Up @@ -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.


<!-- ---------------------------------------------------------------------- -->
Expand All @@ -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.


<!-- ---------------------------------------------------------------------- -->
Expand All @@ -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)).

Expand All @@ -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).


<!-- ---------------------------------------------------------------------- -->
Expand All @@ -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)
2 changes: 1 addition & 1 deletion docs/reference_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
10 changes: 5 additions & 5 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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 = "[email protected]"},
]
Expand Down Expand Up @@ -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"


############################################################
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion test/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

from collections.abc import Iterable, Sequence

from pyproject_qiskit import __version__
from quantum_enablement import __version__


def test_version():
Expand Down
18 changes: 9 additions & 9 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ basepython = python3.12
setenv =
{[testenv]setenv}
commands =
pytest --cov pyproject_qiskit
pytest --cov quantum_enablement


[testenv:lint]
Expand All @@ -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]
Expand All @@ -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


################################################################################
Expand Down
Loading