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.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 64e39d6580b995c117045d050304a78cb7da4f23f9b87360a0b938859925f90c |
|
MD5 | a482dad5cab2ca8e11bb45454e0d1340 |
|
BLAKE2b-256 | a695a01e067585e5e33af121d9dd8ce63a7a748937c75199af052d76f5996b13 |
Hashes for amazon_braket_build_tools-0.2.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0732277e4dff0e6bf9dc4aeb44b5ccb5da5712b062d684b5a570e891e7118758 |
|
MD5 | d50831b7e0196f82f8dee8e6806e7da7 |
|
BLAKE2b-256 | ec5ee7d64a4278c6b0eae83d040c30db16b8c54b4f0ca27bb34100c0cbae6d44 |