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.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 84b014a1736e6238651ed044a0c80c9d788551cdf8bccdd993f8257a7a6b00d1 |
|
MD5 | d8282dd55a736837b9e29f123afc2083 |
|
BLAKE2b-256 | 55f51a6256f7d14f4b0eedaf89a7ee210107bff832f0f8e7f1cc086262e01758 |
Hashes for amazon_braket_build_tools-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 81e1a9cb11d4732c1a3ea0d244b4f59d986de3079aeb0ff5b1607d6ec9c0e3a4 |
|
MD5 | 50cf32f6cd747baa082075963becc6bb |
|
BLAKE2b-256 | e2f5fb303dd08b4e2491bba11211d4ac27d4a0f80721de04ea72a131dda42123 |