Python SDK for codeflare client
Project description
Codeflare-SDK
An intuitive, easy-to-use python interface for batch resource requesting, access, job submission, and observation. Simplifying the developer's life while enabling access to high-performance compute resources, either in the cloud or on-prem.
Tutorial and basics walkthrough coming soon!
Full documentation can be found here
Installation
Can be installed via pip
: pip install codeflare-sdk
Development
Prerequisites
We recommend using Python 3.9 for development.
Install development specific dependencies:
$ pip install -r requirements-dev.txt
Additional dependencies can be found in requirements.txt
: $ pip install -r requirements.txt
Pre-commit
We use pre-commit to make sure the code is consistently formatted. To make sure that pre-commit is run every time you commit changes, simply run pre-commit install
Testing
- To run the unit tests, run
pytest -v tests/unit_test.py
- Any new test functions/scripts can be added into the
tests
folder - NOTE: Functional tests coming soon, will live in
tests/func_test.py
Code Coverage
- Run tests with the following command:
coverage run -m --source=src pytest tests/unit_test.py
- To then view a code coverage report w/ missing lines, run
coverage report -m
Code Formatting
- To check file formatting, in top-level dir run
black --check .
- To auto-reformat all files, remove the
--check
flag - To reformat an individual file, run
black <filename>
Package Build
To build the python package: $ poetry build
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 codeflare_sdk-0.4.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 24b03dec0997f3339c693bc190efb4bdf22a2db3212c50a1dbf7ae18959fa0b9 |
|
MD5 | add9e05374b06f1d5683f10519c92f31 |
|
BLAKE2b-256 | 2b40417064cedb538124c9b15c3c5e7e7ac3821bc95e735cebba0311658b9ddb |