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
asyncinterface 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
1 maintainer
Release files for sfapi-client 0.6.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sfapi_client-0.6.0.tar.gz | 62.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sfapi_client-0.6.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 112.7 kB
Release files / sfapi_client-0.6.0.tar.gz
| Download URL | sfapi_client-0.6.0.tar.gz |
|---|---|
| Size | 62.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
122ac4e2d0688a4af4c7328e0e82449f2378507f4a39bf06d3840337c89a758c
|
|
BLAKE2b-256 checksum How to use checksums |
266bd7fc942cd5fef285c27b2545d867fedbacb491126c92c83ddcc62a4b9002
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 14, 2026.
Transparency logRelease files / sfapi_client-0.6.0-py3-none-any.whl
| Download URL | sfapi_client-0.6.0-py3-none-any.whl |
|---|---|
| Size | 50.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
14396215c662508e2de132357d289bade07f9abb8df2c2a74dc407cc551eacb8
|
|
BLAKE2b-256 checksum How to use checksums |
52ad631cb3b7466682f53eb495608d23ac63826029cd525da7e43c0f9058387b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 14, 2026.
Transparency log
