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
Can be installed via pip: pip install codeflare-sdk
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
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
- To run the unit tests, run
pytest -v tests/unit_test.py - Any new test functions/scripts can be added into the
testsfolder - NOTE: Functional tests coming soon, will live in
tests/func_test.py
- 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
- To check file formatting, in top-level dir run
black --check . - To auto-reformat all files, remove the
--checkflag - To reformat an individual file, run
black <filename>
To build the python package: $ poetry build