# Q# Language Support for Python
Q# is an open-source, high-level programming language for developing and running quantum algorithms.
The `qsharp` package for Python provides interoperability with the Q# interpreter, making it easy
to simulate Q# programs within Python.
## Installation
To install the Q# language package, run:
```bash
pip install qsharp
```
## Usage
First, import the `qsharp` module:
```python
import qsharp
```
Then, use the `%%qsharp` cell magic to run Q# directly in Jupyter notebook cells:
```qsharp
%%qsharp
import Std.Diagnostics.*;
@EntryPoint()
operation BellState() : Unit {
use qs = Qubit[2];
H(qs[0]);
CNOT(qs[0], qs[1]);
DumpMachine();
ResetAll(qs);
}
BellState()
```
## Telemetry
This library sends telemetry. Minimal anonymous data is collected to help measure feature usage and performance.
All telemetry events can be seen in the source file [telemetry_events.py](https://github.com/microsoft/qsharp/tree/main/source/pip/qsharp/telemetry_events.py).
To disable sending telemetry from this package, set the environment variable `QSHARP_PYTHON_TELEMETRY=none`
## Support
For more information about the Azure Quantum Development Kit, visit [https://aka.ms/AQ/Documentation](https://aka.ms/AQ/Documentation).
## Contributing
Q# welcomes your contributions! Visit the Q# GitHub repository at [https://github.com/microsoft/qsharp] to find out more about the project.
Raw data
{
"_id": null,
"home_page": "https://github.com/microsoft/qsharp",
"name": "qsharp",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Microsoft",
"author_email": null,
"download_url": null,
"platform": null,
"description": "# Q# Language Support for Python\n\nQ# is an open-source, high-level programming language for developing and running quantum algorithms.\nThe `qsharp` package for Python provides interoperability with the Q# interpreter, making it easy\nto simulate Q# programs within Python.\n\n## Installation\n\nTo install the Q# language package, run:\n\n```bash\npip install qsharp\n```\n\n## Usage\n\nFirst, import the `qsharp` module:\n\n```python\nimport qsharp\n```\n\nThen, use the `%%qsharp` cell magic to run Q# directly in Jupyter notebook cells:\n\n```qsharp\n%%qsharp\n\nimport Std.Diagnostics.*;\n\n@EntryPoint()\noperation BellState() : Unit {\n use qs = Qubit[2];\n H(qs[0]);\n CNOT(qs[0], qs[1]);\n DumpMachine();\n ResetAll(qs);\n}\n\nBellState()\n```\n\n## Telemetry\n\nThis library sends telemetry. Minimal anonymous data is collected to help measure feature usage and performance.\nAll telemetry events can be seen in the source file [telemetry_events.py](https://github.com/microsoft/qsharp/tree/main/source/pip/qsharp/telemetry_events.py).\n\nTo disable sending telemetry from this package, set the environment variable `QSHARP_PYTHON_TELEMETRY=none`\n\n## Support\n\nFor more information about the Azure Quantum Development Kit, visit [https://aka.ms/AQ/Documentation](https://aka.ms/AQ/Documentation).\n\n## Contributing\n\nQ# welcomes your contributions! Visit the Q# GitHub repository at [https://github.com/microsoft/qsharp] to find out more about the project.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Q# Python Bindings",
"version": "1.20.0",
"project_urls": {
"Homepage": "https://github.com/microsoft/qsharp",
"Source Code": "https://github.com/microsoft/qsharp"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "533b40dfa26c80b2c401c636a5be885e413694da472ef79fcfb7d5c05c87f35d",
"md5": "66094a27e36ca00378f6cb9fc57cb12b",
"sha256": "004e0a43067e3a3f251244a0d28c120b6e6aa0b420d7616dcdcff9454e182a82"
},
"downloads": -1,
"filename": "qsharp-1.20.0-cp39-abi3-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl",
"has_sig": false,
"md5_digest": "66094a27e36ca00378f6cb9fc57cb12b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 5936737,
"upload_time": "2025-08-26T19:23:40",
"upload_time_iso_8601": "2025-08-26T19:23:40.794257Z",
"url": "https://files.pythonhosted.org/packages/53/3b/40dfa26c80b2c401c636a5be885e413694da472ef79fcfb7d5c05c87f35d/qsharp-1.20.0-cp39-abi3-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "39d52828982907d36cfad3d37234346ad6ab1a0743687eae8a74c36bb54a07ee",
"md5": "c23c40eb34e3cc18384ad3281f902dcf",
"sha256": "9f6e6abfacd34ad9c971b1562aa7ecc7b5fa1d51f47d64eeb807854808b95a1b"
},
"downloads": -1,
"filename": "qsharp-1.20.0-cp39-abi3-manylinux_2_35_aarch64.whl",
"has_sig": false,
"md5_digest": "c23c40eb34e3cc18384ad3281f902dcf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 3005740,
"upload_time": "2025-08-26T19:23:43",
"upload_time_iso_8601": "2025-08-26T19:23:43.361722Z",
"url": "https://files.pythonhosted.org/packages/39/d5/2828982907d36cfad3d37234346ad6ab1a0743687eae8a74c36bb54a07ee/qsharp-1.20.0-cp39-abi3-manylinux_2_35_aarch64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "3254ec6b54c6c0e296dbaff77aa32d687ee05455ebaab767b66d291d277b65f3",
"md5": "99839bcc85006b61f70208bdda26da79",
"sha256": "508fc00ba0d64a0eeecc9adacb5166653527c69dad94895f17eeba2f8d6195e8"
},
"downloads": -1,
"filename": "qsharp-1.20.0-cp39-abi3-manylinux_2_35_x86_64.whl",
"has_sig": false,
"md5_digest": "99839bcc85006b61f70208bdda26da79",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 3311503,
"upload_time": "2025-08-26T19:23:45",
"upload_time_iso_8601": "2025-08-26T19:23:45.284364Z",
"url": "https://files.pythonhosted.org/packages/32/54/ec6b54c6c0e296dbaff77aa32d687ee05455ebaab767b66d291d277b65f3/qsharp-1.20.0-cp39-abi3-manylinux_2_35_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "171a5c52165cd59973f82ba2da625b8bc1a1556bbd0a51eece52ea93b5b81197",
"md5": "4c07ffeb0c3d6d3f3085879251bd54e4",
"sha256": "11ce6b8dae21331a08ced0a0d1c3ff412af508156b0f515bfb481049b140ed8d"
},
"downloads": -1,
"filename": "qsharp-1.20.0-cp39-abi3-win_amd64.whl",
"has_sig": false,
"md5_digest": "4c07ffeb0c3d6d3f3085879251bd54e4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 3285204,
"upload_time": "2025-08-26T19:23:47",
"upload_time_iso_8601": "2025-08-26T19:23:47.005561Z",
"url": "https://files.pythonhosted.org/packages/17/1a/5c52165cd59973f82ba2da625b8bc1a1556bbd0a51eece52ea93b5b81197/qsharp-1.20.0-cp39-abi3-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "cacf896f9098cd9b68df0f9a028c1be820706dc5c52230f9c1954ce66c30b9a7",
"md5": "77163c21eafb1f3930ffd1e7476a7b4d",
"sha256": "4a8435fdd008f29768eb8957b5e137cb754ca770cf62a217c23c00a0a97a01b9"
},
"downloads": -1,
"filename": "qsharp-1.20.0-cp39-abi3-win_arm64.whl",
"has_sig": false,
"md5_digest": "77163c21eafb1f3930ffd1e7476a7b4d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 3021812,
"upload_time": "2025-08-26T19:23:48",
"upload_time_iso_8601": "2025-08-26T19:23:48.635848Z",
"url": "https://files.pythonhosted.org/packages/ca/cf/896f9098cd9b68df0f9a028c1be820706dc5c52230f9c1954ce66c30b9a7/qsharp-1.20.0-cp39-abi3-win_arm64.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-26 19:23:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "microsoft",
"github_project": "qsharp",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "qsharp"
}
JSON
