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
For testing, make sure to have installed:
pytest
,pytest-mock
(can both be installed withpip
)- The remaining dependencies located in
requirements.txt
- 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
For checking code coverage while testing:
- Start by installing
coverage
(can be done viapip
) - Now instead when testing run
coverage run -m --source=src pytest tests/unit_test.py
- To then view a code coverage report w/ missing lines, run
coverage report -m
For formatting:
- Currently using black v22.3.0 for format checking
- To install, run
pip install black==22.3.0
- 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>
- To auto-reformat all files, remove the
To build the python package:
- If poetry is not installed:
pip install poetry
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
codeflare_sdk-0.4.0.tar.gz
(21.3 kB
view hashes)
Built Distribution
Close
Hashes for codeflare_sdk-0.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4ccdae16ce731aabf86b7097ae7b9b39f289ea1d20f98482ba7896acfc91d455 |
|
MD5 | 1d46fef5db942cdb9d62e19ac580ab30 |
|
BLAKE2b-256 | eee6e78a6dafb119b57d8fc82a6c66d7afb6ad18763fc4f5dc85400bc27e77d3 |