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.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ed5d7fe4d38d766f3eb6ee3f07d2201a7d5184b6155b5caa3abef84e70b39c2b |
|
MD5 | db28b9465f6f69e189b891a5ae3839f8 |
|
BLAKE2b-256 | 74c0ba5e48c69b9740482b18795357c8fba7bee18face2a2626a65491a4374f7 |
Hashes for amazon_braket_build_tools-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | faf811e97a25075302f39ce728bd12190168a9c70c34cb0787baf70636a44092 |
|
MD5 | 345119ff274998122765299e16d63b5b |
|
BLAKE2b-256 | b2cefaa049925c73b769fb0fe598f4b9060f11e78f99532d38490bd3bfc3ba39 |