Skip to content

Latest commit

 

History

History
109 lines (70 loc) · 4.01 KB

CONTRIBUTING.md

File metadata and controls

109 lines (70 loc) · 4.01 KB
Raw

Contributing to Azure-Quantum-Python

If you would like to become an active contributor to this project please follow the instructions provided in Microsoft Azure Projects Contribution Guidelines.

Pre-requisites

Install pre-reqs:

pip install azure_devtools pytest pytest-azurepipelines pytest-cov

Building and testing

The Azure Quantum team uses Anaconda to create virtual environments for local unit and integration testing as well as in CI/CD.

To create a new conda environment for the azure-quantum package, run at the root of the azure-quantum directory:

conda env create -f environment.yml

Then to activate the environment:

conda activate azurequantum

In case you have created the conda environment a while ago, you can make sure you have the latest versions of all dependencies by updating your environment:

conda env update -f environment.yml --prune

Install the local development package

To install the package in development mode, run:

pip install -e .

Unit tests

To run the unit tests, run pytest from the root of the azure-quantum directory:

pytest

To run the a specific unit test class, run:

pytest ./tests/unit/test_job.py

To run the a specific unit test case, run:

pytest -k test_job_refresh

Recordings

To read more about how to create and update recordings for testing code that interacts with a live API, see the Azure Quantum Unit tests README.

Before merging your code contribution to main, make sure that all new code is covered by unit tests and that the unit tests have up-to-date recordings. If you recorded your tests and then updated or refactored the code afterwards, remember to re-record the tests.

Update/re-generate the Azure Quantum internal SDK client based on Swagger

The internal Azure Quantum Python SDK client (azure/quantum/_client) needs to be re-generated every time there is a change in the Azure Quantum Service API definition (aka Swagger).

To re-generate the client based on the latest published API definition simply run the following PowerShell script

 ./eng/Generate-DataPlane-Client.ps1

See the Generate-DataPlane-Client.ps1 script for more options

After re-generating the client make sure to:

  1. Re-run/Re-record all unit tests against the live-service (you can run ./eng/Record-Tests.ps1)
  2. If necessary, adjust the convenience layer for breaking-changes or to expose new features
  3. Add new unit-tests for new features and record them too

Building the azure-quantum Package wheel

The Azure Quantum Python SDK uses a standard setuptools-based packaging strategy. To build a platform-independent wheel, run the setup script with bdist_wheel instead:

python setup.py bdist_wheel

By default, this will create a azure-quantum wheel in dist/ with the version number set to 0.0.0.1. To provide a more useful version number, set the PYTHON_VERSION environment variable before running setup.py.

Environment Variables

In addition to the common Azure SDK environment variables, you can also set the following environment variables to change the behaviour of the Azure Quantum SDK for Python:

Environment Variable Description
AZURE_QUANTUM_PYTHON_APPID Prefixes the HTTP User-Agent header with the specified value

Code of Conduct

This project's code of conduct can be found in the CODE_OF_CONDUCT.md file.