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.post0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b70cc83c5cfb53b4fd97b4f5d9476aacbae73e5fee2ee27056387475aeb10aec |
|
MD5 | 3d81d9f35d0c58869b020ddcb11fa1b1 |
|
BLAKE2b-256 | 699ebf3c4b00b0ade83d362dd59829ecea6062c44cb9599663388f6d88bd53e6 |
Hashes for amazon_braket_build_tools-0.2.0.post0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2ec7aff5be393b0aae75a3a667f4c3019f3908393fac2d60abb1e25c2d6ab53e |
|
MD5 | 4d194037f218df16840d7e2e5b2f5263 |
|
BLAKE2b-256 | a5a5f3d67701444742417b58c3b899aac92542dd6b02c0f9d534bdaebef21e7b |