Skip to content

Commit

Permalink
feat: AutoQASM public repo setup (#5)
Browse files Browse the repository at this point in the history
* More repo cleanup, remove Braket SDK paths

* Add badges to readme

* Lint

* Comment formatting

* Update docstring example link

* Fix doc formatting

* Update pypi publish action permission
  • Loading branch information
rmshaffer authored May 8, 2024
1 parent e3383db commit 3c8b45b
Show file tree
Hide file tree
Showing 14 changed files with 34 additions and 1,950 deletions.
5 changes: 0 additions & 5 deletions .coveragerc
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,6 @@ branch = True
source =
src
omit =
**/braket/ir/*
**/braket/device_schema/*
**/braket/schema_common/*
**/braket/task_result/*
**/braket/simulator/*
*/site-packages/braket/*

[paths]
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ If applicable, add screenshots or logs to help explain your problem.

**System information**
A description of your system. Please provide:
- **AutoQASM version**:
- **Amazon Braket Python SDK version**:
- **Amazon Braket Python Schemas version**:
- **Amazon Braket Python Default Simulator version**:
Expand Down
6 changes: 3 additions & 3 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ _Put an `x` in the boxes that apply. You can also fill these out after creating

#### General

- [ ] I have read the [CONTRIBUTING](https://github.com/amazon-braket/amazon-braket-sdk-python/blob/main/CONTRIBUTING.md) doc
- [ ] I used the commit message format described in [CONTRIBUTING](https://github.com/amazon-braket/amazon-braket-sdk-python/blob/main/CONTRIBUTING.md#commit-your-change)
- [ ] I have updated any necessary documentation, including [READMEs](https://github.com/amazon-braket/amazon-braket-sdk-python/blob/main/README.md) and [API docs](https://github.com/amazon-braket/amazon-braket-sdk-python/blob/main/CONTRIBUTING.md#documentation-guidelines) (if appropriate)
- [ ] I have read the [CONTRIBUTING](https://github.com/amazon-braket/autoqasm/blob/main/CONTRIBUTING.md) doc
- [ ] I used the commit message format described in [CONTRIBUTING](https://github.com/amazon-braket/autoqasm/blob/main/CONTRIBUTING.md#commit-your-change)
- [ ] I have updated any necessary documentation, including [READMEs](https://github.com/amazon-braket/autoqasm/blob/main/README.md) and [API docs](https://github.com/amazon-braket/autoqasm/blob/main/CONTRIBUTING.md#documentation-guidelines) (if appropriate)

#### Tests

Expand Down
18 changes: 8 additions & 10 deletions .github/scripts/update_dependency.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,21 +14,19 @@
import fileinput
from pathlib import Path

# Here we replace the `amazon-braket-sdk` dependency to point to the file system; otherwise
# Here we replace the `autoqasm` dependency to point to the file system; otherwise
# pip will install them separately, allowing it to override the version of
# any mutual dependencies with the sdk. By pointing to the file system, pip will be
# forced to reconcile the dependencies in setup.py with the dependencies of the sdk,
# any mutual dependencies with AutoQASM. By pointing to the file system, pip will be
# forced to reconcile the dependencies in setup.py with the dependencies of AutoQASM,
# and raise an error if there are conflicts. While we can't do this for every upstream
# dependency, we can do this for the ones we own to make sure that when the sdk updates
# its dependencies, these upstream github repos will not be impacted.
# dependency, we can do this for the ones we own to make sure that when AutoQASM updates
# its dependencies, these upstream GitHub repos will not be impacted.

package = "amazon-braket-sdk"
package = "autoqasm"
path = Path.cwd().parent.resolve()

for line in fileinput.input("setup.py", inplace=True):
# Update the amazon-braket-sdk dependency in setup.py to use the local path. This
# Update the autoqasm dependency in setup.py to use the local path. This
# would help catch conflicts during the installation process.
replaced_line = (
line if package not in line else f'"{package} @ file://{path}/{package}-python",\n'
)
replaced_line = line if package not in line else f'"{package} @ file://{path}/{package}",\n'
print(replaced_line, end="")
4 changes: 2 additions & 2 deletions .github/workflows/publish-to-pypi.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ jobs:
build-and-publish:
name: Build and publish distribution to PyPi
runs-on: ubuntu-latest
permissions:
id-token: write
steps:
- uses: actions/checkout@44c2b7a8a4ea60a981eaca3cf939b5f4305c123b # v4.1.5
- name: Set up Python
Expand All @@ -27,5 +29,3 @@ jobs:
run: python setup.py sdist bdist_wheel
- name: Publish distribution to PyPI
uses: pypa/gh-action-pypi-publish@81e9d935c883d0b210363ab89cf05f3894778450 # release/v1
with:
password: ${{ secrets.pypi_token }}
Loading

0 comments on commit 3c8b45b

Please sign in to comment.