A set of build tools for Amazon Braket
Project description
Braket Build Tools
Installing the Amazon Braket Build Tools
The Amazon Braket Build Tools can be installed with pip as follows:
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:
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:
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:
flake8 --enable-extensions=BCS src
Security
See CONTRIBUTING for more information.
License
This project is licensed under the Apache-2.0 License.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for amazon_braket_build_tools-0.2.11.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2c035ffe0d1448d1558ac7329d4438c05f6b5cf3433e85922b8ea61f2eb62c62 |
|
MD5 | 4a94cf77cb3f0e87ecfbdf709df4174f |
|
BLAKE2b-256 | ce6d8e6423043791613b64c449318adb720cc6f1222c8f856f1750fa61c86bbe |
Hashes for amazon_braket_build_tools-0.2.11-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5afdad900033528f2d3618209580ae0a816ed131acfeb85ac60096eaa62d6593 |
|
MD5 | 721677a48d9d8d58bf66fd57be8b816b |
|
BLAKE2b-256 | d7fedce857d44f7c0a04d6939424a5859ac0999466b26efbecc6576867327dea |