Skip to content

Commit

Permalink
Release prep (#32)
Browse files Browse the repository at this point in the history
  • Loading branch information
IceKhan13 committed May 9, 2022
1 parent 622e3b5 commit 6220dce
Show file tree
Hide file tree
Showing 6 changed files with 42 additions and 21 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/release-package.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,6 @@ jobs:
path: ./dist/qiskit*
- name: Publish to PyPi
env:
TWINE_PASSWORD: ${{ secrets.TWINE_PASSWORD }}
TWINE_USERNAME: qiskit
TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
run: twine upload dist/qiskit*
19 changes: 9 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,18 @@ Qiskit-Braket provider to execute Qiskit programs on AWS quantum computing hardw

##### For Users

1. [About the Project](docs/project_overview.md)
2. [Installation](docs/installation_guide.md)
3. [Quickstart Guide](docs/quickstart_guide.md)
4. [Tutorials](docs/tutorials/)
5. [How-Tos](docs/how_tos/)
6. [How to Give Feedback](#how-to-give-feedback)
7. [Contribution Guidelines](#contribution-guidelines)
8. [References and Acknowledgements](#references-and-acknowledgements)
9. [License](#license)
1. [Installation](https://github.com/qiskit-community/qiskit-braket-provider/blob/main/docs/installation_guide.md)
2. [Quickstart Guide](https://github.com/qiskit-community/qiskit-braket-provider/blob/main/docs/quickstart_guide.md)
3. [Tutorials](https://github.com/qiskit-community/qiskit-braket-provider/blob/main/docs/tutorials/)
4. [How-Tos](https://github.com/qiskit-community/qiskit-braket-provider/blob/main/docs/how_tos/)
5. [How to Give Feedback](#how-to-give-feedback)
6. [Contribution Guidelines](#contribution-guidelines)
7. [References and Acknowledgements](#references-and-acknowledgements)
8. [License](#license)

##### For Developers/Contributors

1. [Contribution Guide](CONTRIBUTING.md)
1. [Contribution Guide](https://github.com/qiskit-community/qiskit-braket-provider/blob/main/CONTRIBUTING.md)


----------------------------------------------------------------------------------------------------
Expand Down
17 changes: 13 additions & 4 deletions docs/installation_guide.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,32 @@
# Qiskit-Braket Installation Guide

## Installing Depencencies
## PyPi

```shell
pip install qiskit_braket_provider
```

## Local installation

1. Clone repo
2. Installing Depencencies

```shell
pip install -r requirements.txt
```

## Installing Optional Dependencies
3. Installing Optional Dependencies

```shell
pip install -r requirements-dev.txt
```
## Installing Qiskit-Braket provider
4. Installing Qiskit-Braket provider

```shell
pip install .
```

## Testing the Installation
5. Testing the Installation

```shell
tox -epy39
Expand Down
4 changes: 1 addition & 3 deletions docs/quickstart_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,4 @@ Refer to [installation guide](./installation_guide.md).

## Usage

```python

```
Refer to [how-to-guidelines](./how_tos) or [tutorials](./tutorials).
4 changes: 2 additions & 2 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ qiskit-terra>=0.19.2
amazon-braket-sdk>=1.18.0
retrying==1.3.3

setuptools~=60.9.3
numpy>=1.3
setuptools>=40.1.0
numpy>=1.3
15 changes: 15 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,23 @@
"hardware devices through Amazon Braket.",
long_description=long_description,
long_description_content_type="text/markdown",
keywords="qiskit braket sdk quantum",
packages=setuptools.find_packages(),
install_requires=install_requires,
python_requires=">=3.7",
version=version,
classifiers=[
"Intended Audience :: Developers",
"Intended Audience :: Science/Research",
"License :: OSI Approved :: Apache Software License",
"Natural Language :: English",
"Operating System :: MacOS",
"Operating System :: POSIX :: Linux",
"Operating System :: Microsoft :: Windows",
"Programming Language :: Python :: 3.7",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Topic :: Scientific/Engineering :: Physics",
],
)

0 comments on commit 6220dce

Please sign in to comment.