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.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0d9d758dfafa29b2b14751c65f1f664f7b7338e22987309b13108956c6eba226 |
|
MD5 | 6b7147dfd261e834e85c3eaf02101261 |
|
BLAKE2b-256 | fc5dfceb913a19f0e4a61381435390098549c1152bbd7c0b608e9cefe6eb40b5 |
Hashes for amazon_braket_build_tools-0.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 351dadf72b24e6cceea91a3a087fe03a8786f083d7900137fb2f7bd558798194 |
|
MD5 | 74982f0dd87fad6ef87fa21af32c5206 |
|
BLAKE2b-256 | 8651ac80579dd151202e60197d4c0e2f438e9c464fbfba1978bde805ba24b4eb |