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.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 942499816872c17b2f03ad1c6f83e5341b73cc98333ad974dfc0fd79de8b6512 |
|
MD5 | a1ea8677a982c63cee62a70ebcd78f2a |
|
BLAKE2b-256 | f5ced3dfc36b5f0035f383cbf7f68da9d48a07c24a53e366f990ab78022d769b |
Hashes for amazon_braket_build_tools-0.2.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8fd354cc17f68368363fbd8683b264d44e31bb197ac5862526051bebcd163cc1 |
|
MD5 | d9a46a473689803db77faf3f105b2102 |
|
BLAKE2b-256 | 34707e7b82928709bb3eaa2aeb9baa45126f359a8dc6e4e88b1620fbbe7d84a4 |