## Braket Build Tools
## Installing the Amazon Braket Build Tools
The Amazon Braket Build Tools can be installed with pip as follows:
```bash
pip install amazon-braket-build-tools
```
You can also install from source by cloning this repository and running a pip install command in the root directory of the repository:
```bash
git clone https://github.com/aws/amazon-braket-build-tools.git
cd amazon-braket-build-tools
pip install .
```
### Flake8 Checkstyle Plugin
This tool checks python source code for Braket checkstyle standards as a Flake8 plugin.
Installing amazon-braket-build-tools automatically registers this plugin with flake8 and
will be run by default whenever flake8 is used.
#### Testing The Installation
To test if the extension has been installed run:
```bash
flake8 --enable-extensions=BCS --help
```
At the bottom of the output you should see braket checkstyle among your installed plugins:
```
Installed plugins: braket.flake8_plugins.braket_checkstyle_plugin: 0.1.0
```
#### Running
To run with the extension enabled, just run flake8 on the module of your choice.
For example:
```bash
flake8 --enable-extensions=BCS src
```
## Security
See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
## License
This project is licensed under the Apache-2.0 License.
Raw data
{
"_id": null,
"home_page": "https://github.com/aws/amazon-braket-build-tools",
"name": "amazon-braket-build-tools",
"maintainer": "",
"docs_url": null,
"requires_python": ">= 3.8",
"maintainer_email": "",
"keywords": "Amazon AWS Quantum",
"author": "Amazon Web Services",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/25/cf/308e95d987be4ac643ecb993609236a797ecb078db98a8175d78523001d7/amazon-braket-build-tools-0.2.8.tar.gz",
"platform": null,
"description": "## Braket Build Tools\n\n## Installing the Amazon Braket Build Tools\n\nThe Amazon Braket Build Tools can be installed with pip as follows:\n\n```bash\npip install amazon-braket-build-tools\n```\n\nYou can also install from source by cloning this repository and running a pip install command in the root directory of the repository:\n\n```bash\ngit clone https://github.com/aws/amazon-braket-build-tools.git\ncd amazon-braket-build-tools\npip install .\n```\n\n### Flake8 Checkstyle Plugin\n\nThis tool checks python source code for Braket checkstyle standards as a Flake8 plugin.\nInstalling amazon-braket-build-tools automatically registers this plugin with flake8 and\nwill be run by default whenever flake8 is used.\n\n#### Testing The Installation\nTo test if the extension has been installed run:\n```bash\nflake8 --enable-extensions=BCS --help\n```\nAt the bottom of the output you should see braket checkstyle among your installed plugins:\n```\nInstalled plugins: braket.flake8_plugins.braket_checkstyle_plugin: 0.1.0\n```\n\n#### Running\nTo run with the extension enabled, just run flake8 on the module of your choice.\nFor example:\n```bash\nflake8 --enable-extensions=BCS src\n```\n\n\n## Security\n\nSee [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.\n\n## License\n\nThis project is licensed under the Apache-2.0 License.\n\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "A set of build tools for Amazon Braket",
"version": "0.2.8",
"project_urls": {
"Homepage": "https://github.com/aws/amazon-braket-build-tools"
},
"split_keywords": [
"amazon",
"aws",
"quantum"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ccf07c613dfeb2c26ed34a32d251d3ec486a067f3b19c51de2c3a6e547abcc31",
"md5": "ea36010585593725ced4aaedc1d67838",
"sha256": "a987612e2d5fdb4b89769ab3950b0884de8ebef68f0e3b5479441fd936729628"
},
"downloads": -1,
"filename": "amazon_braket_build_tools-0.2.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ea36010585593725ced4aaedc1d67838",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">= 3.8",
"size": 11839,
"upload_time": "2023-10-19T16:04:16",
"upload_time_iso_8601": "2023-10-19T16:04:16.934070Z",
"url": "https://files.pythonhosted.org/packages/cc/f0/7c613dfeb2c26ed34a32d251d3ec486a067f3b19c51de2c3a6e547abcc31/amazon_braket_build_tools-0.2.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "25cf308e95d987be4ac643ecb993609236a797ecb078db98a8175d78523001d7",
"md5": "6394e7ac823f78ddfd88a1965f3dff50",
"sha256": "8bfb0e17dc9b984a71d9a1c277d9b0347c8efc4007c71e1b8c7df261abe1dda1"
},
"downloads": -1,
"filename": "amazon-braket-build-tools-0.2.8.tar.gz",
"has_sig": false,
"md5_digest": "6394e7ac823f78ddfd88a1965f3dff50",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">= 3.8",
"size": 10836,
"upload_time": "2023-10-19T16:04:17",
"upload_time_iso_8601": "2023-10-19T16:04:17.904532Z",
"url": "https://files.pythonhosted.org/packages/25/cf/308e95d987be4ac643ecb993609236a797ecb078db98a8175d78523001d7/amazon-braket-build-tools-0.2.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-19 16:04:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aws",
"github_project": "amazon-braket-build-tools",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "amazon-braket-build-tools"
}
JSON
