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.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 44dd08ad88181572d3ea41494cdff7d436b201dcaf31cafee4fca0c3dd078626 |
|
MD5 | 8100c5c9b5440dde357d142430658b66 |
|
BLAKE2b-256 | b1afa1457a35a994daacc622d5f6e4635c6fc18fad0ebe0397b87627fb32d965 |
Hashes for amazon_braket_build_tools-0.2.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f2bf5d43055829277c6b5d82f16b0a94d2463fcd0457b654ab963315f94cb3bd |
|
MD5 | ef9ca28384dc911a2fcd56d9fbe2c42d |
|
BLAKE2b-256 | 3573bbe722949c647158487e853afdfc65868a017dff799ba50a13b11c4585e0 |