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.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fa4874b1b4dd87798e417759d82344def53efdf2f10b52e53027d936de9c03a4 |
|
MD5 | c93f48e56b38cb53d982ff04c3e7e8da |
|
BLAKE2b-256 | b6b2365c0752e1d2286a51e38f1a3782e5f3c22ddfd6d1def0eda7a377ca9941 |
Hashes for amazon_braket_build_tools-0.2.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9f11769dcb848b1a34076d3bb9c8874835b83a64f24acf2b2973cdafad13e0a1 |
|
MD5 | fe3b058d11c87a25f99fa2d2f4a74fa1 |
|
BLAKE2b-256 | 0ffb079a5cb7136a55c723e66abc05d8f6251f18cc5e00d69a7facbb3e8fc6e0 |