Skip to main content

Python client for NERSC SF API

Project description

Welcome to sfapi_client

sfapi_client is a Python 3 client for NERSC's Superfacility API.


Install sfapi_client using pip:

$ pip install sfapi_client

Let's get started by checking the status of perlmutter:

>>> from sfapi_client import Client
>>> from sfapi_client.compute import Machine
>>> with Client() as client:
...     status = client.compute(Machine.perlmutter)
...
>>> status
Compute(name='perlmutter', full_name='Perlmutter', description='System Degraded', system_type='compute', notes=['2023-04-26 18:16 -- 2023-04-28 09:30 PDT, System Degraded, Rolling reboots are complete, a final reboot is scheduled for 0930 PDT'], status=<StatusValue.degraded: 'degraded'>, updated_at=datetime.datetime(2023, 4, 26, 18, 16, tzinfo=datetime.timezone(datetime.timedelta(days=-1, seconds=61200))), client=<sfapi_client._sync.client.Client object at 0x102c871c0>)

Features

  • async interface and standard synchronous interface.
  • Fully type annotated.

Documentation

For the basics, head over to the QuickStart. We also have Jupyter Notebook examples.

More in depth developer documentation can be found in the API reference.

Dependencies

The sfapi_client project relies on these libraries:

  • httpx - HTTP support.
  • authlib - OAuth 2.0 authentication.
  • pydantic - Data models.
  • tenacity - Retry.
  • datamodel-code-generator - Generating data models from the Open API specification.
  • unasync - Generating synchronous interface from the async implementation.

Installation

Install with pip:

$ pip install sfapi_client

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sfapi_client-0.3.1.tar.gz (56.1 kB view details)

Uploaded Source

Built Distribution

sfapi_client-0.3.1-py3-none-any.whl (44.5 kB view details)

Uploaded Python 3

File details

Details for the file sfapi_client-0.3.1.tar.gz.

File metadata

  • Download URL: sfapi_client-0.3.1.tar.gz
  • Upload date:
  • Size: 56.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for sfapi_client-0.3.1.tar.gz
Algorithm Hash digest
SHA256 63f3c0ce6153a248bce83b7f992b4b1394ba584cc9c946831980641a4dc4dfe8
MD5 8252c25670b36a7cd199e14c3f99e6d9
BLAKE2b-256 9e17ef24e392d1ef7aebf4ed718d16099dda89dc830e871ca721459a2911d845

See more details on using hashes here.

Provenance

File details

Details for the file sfapi_client-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: sfapi_client-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 44.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for sfapi_client-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2a1aa5b009db166da8627ba8d080863202c21f416e5580d742c5423b4d49968e
MD5 6456de2cf30a5bd4c9fcd145b0302301
BLAKE2b-256 c87c4d3ac7d1243571d7e62a05e1915c87e863a1a0b69500b0c14f7a5cafdc27

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page