autoqasm 0.1.0__tar.gz

autoqasm-0.1.0/.coveragerc

@@ -0,0 +1,34 @@
+[run]
+parallel = True
+branch = True
+source =
+    src
+omit =
+    */site-packages/braket/*
+
+[paths]
+source =
+    src
+    */site-packages/braket
+
+[report]
+show_missing = True
+ignore_errors = True
+exclude_lines =
+    # Have to re-enable the standard pragma
+    pragma: no cover
+
+    # Skipping import testing
+    from importlib.metadata import entry_points
+ 
+    # Don't complain if tests don't hit defensive assertion code:
+    raise NotImplementedError
+
+    # Avoid situation where system version causes coverage issues
+    if sys.version_info.minor == 9:
+
+[html]
+directory = build/coverage
+
+[xml]
+output = build/coverage/coverage.xml

autoqasm-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,8 @@
+repos:
+  - repo: local
+    hooks:
+      - id: tox_linters
+        name: linters
+        entry: tox -e linters_check
+        language: system
+        types: [python]

autoqasm-0.1.0/.readthedocs.yml

@@ -0,0 +1,27 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: doc/conf.py
+
+# Optionally build your docs in additional formats such as PDF
+formats:
+  - pdf
+
+# setting up build.os and the python version
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.9"
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+  install:
+    - method: pip
+      path: .
+    - requirements: doc/requirements.txt

autoqasm-0.1.0/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## v0.1.0 (2024-05-22)
+
+This is the initial pre-release version of AutoQASM.
+
+AutoQASM is an experimental module offering a new quantum-imperative programming experience in Python for developing quantum programs.

autoqasm-0.1.0/CODEOWNERS

@@ -0,0 +1,6 @@
+# https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners
+
+# These owners will be the default owners for everything in
+# the repo. Unless a later match takes precedence, these accounts
+# will be requested for review when someone opens a pull request.
+* @amazon-braket/braket-dev

autoqasm-0.1.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,4 @@
+## Code of Conduct
+This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
+For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
+opensource-codeofconduct@amazon.com with any additional questions or comments.

autoqasm-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,224 @@
+# Contributing Guidelines
+
+Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional
+documentation, we greatly value feedback and contributions from our community.
+
+Please read through this document before submitting any issues or pull requests to ensure we have all the necessary
+information to effectively respond to your bug report or contribution.
+
+
+## Table of Contents
+
+* [Report Bugs/Feature Requests](#report-bugsfeature-requests)
+* [Contribute via Pull Requests (PRs)](#contribute-via-pull-requests-prs)
+  * [Pull Down the Code](#pull-down-the-code)
+  * [Run the Unit Tests](#run-the-unit-tests)
+  * [Run the Integration Tests](#run-the-integration-tests)
+  * [Make and Test Your Change](#make-and-test-your-change)
+  * [Commit Your Change](#commit-your-change)
+  * [Send a Pull Request](#send-a-pull-request)
+* [Documentation Guidelines](#documentation-guidelines)
+  * [API References (docstrings)](#api-references-docstrings)
+  * [Build and Test Documentation](#build-and-test-documentation)
+* [Find Contributions to Work On](#find-contributions-to-work-on)
+* [Building Integrations](#building-integrations)
+* [Code of Conduct](#code-of-conduct)
+* [Security Issue Notifications](#security-issue-notifications)
+* [Licensing](#licensing)
+
+## Report Bugs/Feature Requests
+
+We welcome you to use the GitHub issue tracker to report bugs or suggest features.
+
+When filing an issue, please check [existing open](https://github.com/amazon-braket/autoqasm/issues) and [recently closed](https://github.com/amazon-braket/autoqasm/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20) issues to make sure somebody else hasn't already
+reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
+
+* A reproducible test case or series of steps.
+* The version of our code being used.
+* Any modifications you've made relevant to the bug.
+* A description of your environment or deployment.
+
+
+## Contribute via Pull Requests (PRs)
+
+Contributions via pull requests are much appreciated.
+
+Before sending us a pull request, please ensure that:
+
+* You are working against the latest source on the *main* branch.
+* You check the existing open and recently merged pull requests to make sure someone else hasn't already addressed the problem.
+* You open an issue to discuss any significant work - we would hate for your time to be wasted.
+
+
+### Pull Down the Code
+
+1. If you do not already have one, create a GitHub account by following the prompts at [Join GitHub](https://github.com/join).
+1. Create a fork of this repository on GitHub. You should end up with a fork at `https://github.com/<username>/autoqasm`.
+   1. Follow the instructions at [Fork a Repo](https://help.github.com/en/articles/fork-a-repo) to fork a GitHub repository.
+1. Clone your fork of the repository: `git clone https://github.com/<username>/autoqasm` where `<username>` is your github username.
+
+
+### Run the Unit Tests
+
+1. Install tox using `pip install tox`
+1. Install coverage using `pip install '.[test]'`
+1. cd into the autoqasm folder: `cd autoqasm` or `cd /environment/autoqasm`
+1. Run the following tox command and verify that all unit tests pass: `tox -e unit-tests`
+
+You can also pass in various pytest arguments `tox -e unit-tests -- your-arguments` to run selected tests. For more information, please see [pytest usage](https://docs.pytest.org/en/stable/usage.html).
+
+
+### Make and Test Your Change
+
+1. Create a new git branch:
+     ```shell
+     git checkout -b my-fix-branch main
+     ```
+1. Make your changes, **including unit tests** and, if appropriate, integration tests.
+   1. Include unit tests when you contribute new features or make bug fixes, as they help to:
+      1. Prove that your code works correctly.
+      1. Guard against future breaking changes to lower the maintenance cost.
+   1. Please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
+1. Run `tox`, to run all the unit tests, linters, and documentation creation, and verify that all checks and tests pass.
+1. If your changes include documentation changes, please see the [Documentation Guidelines](#documentation-guidelines).
+
+
+### Commit Your Change
+
+We use commit messages to update the project version number and generate changelog entries, so it's important for them to follow the right format. Valid commit messages include a prefix, separated from the rest of the message by a colon and a space. Here are a few examples:
+
+```
+feature: support new parameter for `xyz`
+fix: fix flake8 errors
+documentation: add documentation for `xyz`
+```
+
+Valid prefixes are listed in the table below.
+
+| Prefix          | Use for...                                                                                     |
+|----------------:|:-----------------------------------------------------------------------------------------------|
+| `breaking`      | Incompatible API changes.                                                                      |
+| `deprecation`   | Deprecating an existing API or feature, or removing something that was previously deprecated.  |
+| `feature`       | Adding a new feature.                                                                          |
+| `fix`           | Bug fixes.                                                                                     |
+| `change`        | Any other code change.                                                                         |
+| `documentation` | Documentation changes.                                                                         |
+
+Some of the prefixes allow abbreviation ; `break`, `feat`, `depr`, and `doc` are all valid. If you omit a prefix, the commit will be treated as a `change`.
+
+For the rest of the message, use imperative style and keep things concise but informative. See [How to Write a Git Commit Message](https://chris.beams.io/posts/git-commit/) for guidance.
+
+
+### Send a Pull Request
+
+GitHub provides additional documentation on [Creating a Pull Request](https://help.github.com/articles/creating-a-pull-request/).
+
+Please remember to:
+* Use commit messages (and PR titles) that follow the guidelines under [Commit Your Change](#commit-your-change).
+* Send us a pull request, answering any default questions in the pull request interface.
+* Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
+
+
+```mermaid
+timeline
+    title Code integration journey (CI)
+    Project setup <br> (make dev)   : Code checkout
+                                    : Virtual environment
+                                    : Dependencies
+                                    : Local branch
+                                    : Local changes
+                                    : Local tests
+
+    Pre-Pull Request <br> (make PR)     : Code linting (tox -e linters)
+                                        : Docs linting (tox -e docs)
+                                        : Static typing analysis (covered by the linters)
+                                        : Tests (tox -e unit-tests)
+
+    Pull Request <br> (CI checks)   : Semantic PR title check
+                                    : Related issue check
+                                    : Acknowledgment check
+                                    : Code coverage diff
+                                    : Dependencies check
+
+    After merge <br> (CI checks)    : End-to-end tests
+                                    : GitHub Actions check
+                                    : Rebuild Changelog
+                                    : Deploy staging docs
+                                    : Prepare release
+```
+
+## Documentation Guidelines
+
+We use reStructuredText (RST) for most of our documentation. For a quick primer on the syntax,
+see [the Sphinx documentation](https://www.sphinx-doc.org/en/main/usage/restructuredtext/basics.html).
+
+In this repository, we the docstrings create the API reference found on readthedocs.
+
+Here are some general guidelines to follow when writing either kind of documentation:
+* Use present tense.
+  * 👍 "The device has this property..."
+  * 👎 "The device will have this property."
+* When referring to an AWS product, use its full name in the first invocation.
+  (This applies only to prose; use what makes sense when it comes to writing code, etc.)
+  * 👍 "Amazon S3"
+  * 👎 "s3"
+* Provide links to other ReadTheDocs pages, AWS documentation, etc. when helpful.
+  Try to not duplicate documentation when you can reference it instead.
+  * Use meaningful text in a link.
+
+
+### API References (docstrings)
+
+The API references are generated from docstrings.
+A docstring is the comment in the source code that describes a module, class, function, or variable.
+
+```python
+def foo():
+    """This comment is a docstring for the function foo."""
+```
+
+We use [Google-style docstrings](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html).
+There should be a docstring for every public module, class, and function.
+For functions, make sure your docstring covers all of the arguments, exceptions, and any other relevant information.
+When possible, link to classes and functions, e.g. use ":class:~\`braket.aws.AwsSession\`" over just "AwsSession."
+
+If a parameter of a function has a default value, please note what the default is.
+If that default value is `None`, it can also be helpful to explain what happens when the parameter is `None`.
+If `**kwargs` is part of the function signature, link to the parent class(es) or method(s) so that the reader knows where to find the available parameters.
+
+For an example file with docstrings, see [the `measurements` module](https://github.com/amazon-braket/autoqasm/blob/main/src/autoqasm/instructions/measurements.py).
+
+
+### Build and Test Documentation
+
+To build the Sphinx docs, run the following command in the root repo directory:
+
+```shell
+tox -e docs
+```
+
+You can then find the generated HTML files in `build/documentation/html`.
+
+
+## Find Contributions to Work On
+
+Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](https://github.com/amazon-braket/autoqasm/labels/help%20wanted) issues is a great place to start.
+
+
+## Code of Conduct
+
+This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
+For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
+opensource-codeofconduct@amazon.com with any additional questions or comments.
+
+
+## Security Issue Notifications
+
+If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.
+
+
+## Licensing
+
+See the [LICENSE](https://github.com/amazon-braket/autoqasm/blob/main/LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
+
+We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes.

autoqasm-0.1.0/LICENSE

@@ -0,0 +1,175 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.

autoqasm-0.1.0/MANIFEST.in

@@ -0,0 +1,14 @@
+include *.md
+include *.yaml
+include *.yml
+include .coveragerc
+include CODEOWNERS
+include tox.ini
+recursive-include src *.json
+recursive-include bin *.py
+recursive-include doc *.py
+recursive-include doc *.rst
+recursive-include doc *.txt
+recursive-include doc Makefile
+recursive-include examples *.py
+recursive-include test *.py

autoqasm-0.1.0/NOTICE

@@ -0,0 +1 @@
+Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.