From a5e32ff0dad3552012a6ea6a63312ca8db868e64 Mon Sep 17 00:00:00 2001 From: Ryan Hill Date: Fri, 4 Oct 2024 13:21:47 -0500 Subject: [PATCH] workflows + release (#2) * fix workflows, update changelog, add badges * add install / warning * fix format --- .github/workflows/pre-release.yml | 2 +- .../workflows/{publish.yaml => release.yml} | 2 +- CHANGELOG.md | 8 +++++++- README.md | 19 ++++++++++++++++++- 4 files changed, 27 insertions(+), 4 deletions(-) rename .github/workflows/{publish.yaml => release.yml} (96%) diff --git a/.github/workflows/pre-release.yml b/.github/workflows/pre-release.yml index 8dc1185..8020e9d 100644 --- a/.github/workflows/pre-release.yml +++ b/.github/workflows/pre-release.yml @@ -7,7 +7,7 @@ jobs: pypi-publish: name: Build pre-release dist & upload to PyPI runs-on: ubuntu-latest - environment: publish + environment: release steps: - uses: actions/checkout@v4 with: diff --git a/.github/workflows/publish.yaml b/.github/workflows/release.yml similarity index 96% rename from .github/workflows/publish.yaml rename to .github/workflows/release.yml index a7bb736..2312876 100644 --- a/.github/workflows/publish.yaml +++ b/.github/workflows/release.yml @@ -9,7 +9,7 @@ jobs: pypi-publish: name: Build dist & upload to PyPI runs-on: ubuntu-latest - environment: publish + environment: release steps: - uses: actions/checkout@v4 with: diff --git a/CHANGELOG.md b/CHANGELOG.md index ddc0941..3f7d4f3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -24,4 +24,10 @@ Types of changes: ### Fixed -### Dependencies \ No newline at end of file +### Dependencies + +## [0.0.0] - 2024-10-04 + +### Added +- Setup basic project/repo template ([#1](https://github.com/qBraid/pyqasm/pull/1)) +- Configured PyPI workflows ([#2](https://github.com/qBraid/pyqasm/pull/2)) \ No newline at end of file diff --git a/README.md b/README.md index 89e5806..e8ccdb0 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,20 @@ # pyqasm -Python toolkit providing an OpenQASM 3 semantic analyzer and utilities for program analysis and compilation. \ No newline at end of file +[![PyPI version](https://img.shields.io/pypi/v/pyqasm.svg?color=blue)](https://pypi.org/project/pyqasm/) +[![Python verions](https://img.shields.io/pypi/pyversions/pyqasm.svg?color=blue)](https://pypi.org/project/pyqasm/) +[![GitHub](https://img.shields.io/badge/issue_tracking-github-black?logo=github)](https://github.com/qBraid/pyqasm/issues) +[![License](https://img.shields.io/github/license/qBraid/pyqasm.svg?color=purple)](https://www.gnu.org/licenses/gpl-3.0.html) +[![QCSE](https://img.shields.io/badge/QCSE-pyqasm-orange?logo=stackexchange)](https://quantumcomputing.stackexchange.com/questions/tagged/pyqasm) + +Python toolkit providing an OpenQASM 3 semantic analyzer and utilities for program analysis and compilation. + +## Installation + +pyqasm requires Python 3.10 or greater, and can be installed with pip as follows: + +```bash +pip install pyqasm +``` + +>[!WARNING] +> **This project is "pre-alpha", and is not yet stable or fully realized. Use with caution, as the API and functionality are subject to significant changes.** \ No newline at end of file