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.10.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a459329274748cde77c368d650b3bb794c76fbd3e51b30a0fd6343f2074d207c |
|
MD5 | e3dc827c0888208b3513cfdb7b3a10c2 |
|
BLAKE2b-256 | 73508ebb1abc9b04fe1d53c06119d092938fa493c74cc05caee3dcc7205cb956 |
Hashes for amazon_braket_build_tools-0.2.10-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 876cadf4af0c30d7be90866d633ecb9fc963f738e17e3a8fc86a307056f883f8 |
|
MD5 | 7e2502ca11339de3147453696bcb276a |
|
BLAKE2b-256 | 51ae03c0e87a88159946b60b60481a94b7f9bab6428a152aad0b0bcb0ecc5c0c |