Codeflare-SDK

Python application coverage badge

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 links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.39.0)

10 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for arceofrancisco from gravatar.com arceofrancisco Avatar for bobbins228 from gravatar.com bobbins228 Avatar for chipspeak from gravatar.com chipspeak
+7 more Avatar for eoinfennessy from gravatar.com eoinfennessy Avatar for kpostlet from gravatar.com kpostlet Avatar for kryanbeane from gravatar.com kryanbeane Avatar for laurafitzgerald from gravatar.com laurafitzgerald Avatar for pmccarthy from gravatar.com pmccarthy Avatar for ppaszki from gravatar.com ppaszki Avatar for szaher from gravatar.com szaher

Credits

Author: Michael Clifford

License

Apache Software License (Apache-2.0)

Requires

Python >=3.7, <4.0

Tags

codeflare python sdk client batch scale

Classifiers

Report project as malware

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.2.tar.gz (21.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

codeflare_sdk-0.4.2-py3-none-any.whl (31.0 kB view details)

Uploaded Python 3

File details

Details for the file codeflare_sdk-0.4.2.tar.gz.

File metadata

  • Download URL: codeflare_sdk-0.4.2.tar.gz
  • Upload date:
  • Size: 21.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.1 CPython/3.8.13 Linux/4.18.0-425.10.1.el8_7.x86_64

File hashes

Hashes for codeflare_sdk-0.4.2.tar.gz
Algorithm Hash digest
SHA256 59bd95e61f4e66e58c9507ead3ed56f60b4e6df79cffc97601f2f0cdef565913
MD5 33587d4492a0120bd22513068640cd12
BLAKE2b-256 f9583fb6d5e2d3d0063ce580c9e96aa818e24a9ea41a4306be164da25795628f

See more details on using hashes here.

File details

Details for the file codeflare_sdk-0.4.2-py3-none-any.whl.

File metadata

  • Download URL: codeflare_sdk-0.4.2-py3-none-any.whl
  • Upload date:
  • Size: 31.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.1 CPython/3.8.13 Linux/4.18.0-425.10.1.el8_7.x86_64

File hashes

Hashes for codeflare_sdk-0.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 24b03dec0997f3339c693bc190efb4bdf22a2db3212c50a1dbf7ae18959fa0b9
MD5 add9e05374b06f1d5683f10519c92f31
BLAKE2b-256 2b40417064cedb538124c9b15c3c5e7e7ac3821bc95e735cebba0311658b9ddb

See more details on using hashes here.

Release history Release notifications | RSS feed

0.39.0

2 files

0.38.2

2 files

0.38.1

2 files

0.38.0

2 files

0.37.0

2 files

0.36.0

2 files

0.35.0

2 files

0.34.0

2 files

0.33.1

2 files

0.33.0

2 files

0.32.2

2 files

0.32.1

2 files

0.32.0

2 files

0.31.5

2 files

0.31.3

2 files

0.31.2

2 files

0.31.1

2 files

0.31.0

2 files

0.30.0

2 files

0.29.0

2 files

0.28.1

2 files

0.28.0

2 files

0.27.0

2 files

0.26.0

2 files

0.25.0

2 files

0.24.3

2 files

0.24.2

2 files

0.24.1

2 files

0.24.0

2 files

0.23.1

2 files

0.23.0

2 files

0.22.0

2 files

0.21.1

2 files

0.21.0

2 files

0.20.2

2 files

0.20.0

2 files

0.19.1

2 files

0.19.0

2 files

0.18.0

2 files

0.17.0

2 files

0.16.4

2 files

0.16.3

2 files

0.16.2

2 files

0.16.1

2 files

0.16.0

2 files

0.15.1

2 files

0.15.0

2 files

0.14.1

2 files

0.14.0

2 files

0.13.0

2 files

0.12.1

2 files

0.12.0

2 files

0.11.0

2 files

0.10.1

2 files

0.10.0

2 files

0.9.0

2 files

0.8.0

2 files

0.7.1

2 files

0.7.0

2 files

0.6.1

2 files

0.5.0

2 files

0.4.5

2 files

0.4.4

2 files

0.4.3

2 files

This release

0.4.2 This release

2 files

0.4.1

2 files

0.4.0

2 files

0.3.1

2 files

0.3.0

2 files

0.2.2

2 files

0.2.1

2 files

0.2.0

2 files

0.1.7

2 files

0.1.6

2 files

0.1.5

2 files

0.1.4

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

0.0.4

2 files

0.0.3

2 files

0.0.2

2 files

0.0.1

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page