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.7.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ef1dba9e26f19a18eddf817719148e7712b3e806d87dfe17c5408744e045c644 |
|
MD5 | 3b31fb9c4e7526f627ba4d33acab7031 |
|
BLAKE2b-256 | 7b84416a357b65f309937c52df5afae54810f7df0774203667e330e961dc5e8f |
Hashes for amazon_braket_build_tools-0.2.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ecf802d380cdb5bd83db93271b980d4715fd5743f79f8a5a193acd98f1359232 |
|
MD5 | 440bec82533d8fcce355ec6268da8838 |
|
BLAKE2b-256 | d1615ef73a1f88a7571ec9dbaa8846a2a84ca7c47b081b690577611587b64255 |