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.8.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8bfb0e17dc9b984a71d9a1c277d9b0347c8efc4007c71e1b8c7df261abe1dda1 |
|
MD5 | 6394e7ac823f78ddfd88a1965f3dff50 |
|
BLAKE2b-256 | 25cf308e95d987be4ac643ecb993609236a797ecb078db98a8175d78523001d7 |
Hashes for amazon_braket_build_tools-0.2.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a987612e2d5fdb4b89769ab3950b0884de8ebef68f0e3b5479441fd936729628 |
|
MD5 | ea36010585593725ced4aaedc1d67838 |
|
BLAKE2b-256 | ccf07c613dfeb2c26ed34a32d251d3ec486a067f3b19c51de2c3a6e547abcc31 |