Gravix Layer Python SDK
Official Python client for Gravix Layer — create and manage cloud agent runtimes and templates for your workloads.
New to this SDK?
| Step | Action |
|---|---|
| 1 | Install: pip install gravixlayer |
| 2 | Set API key: export GRAVIXLAYER_API_KEY="your-api-key" (from the Gravix Layer console) |
| 3 | Run the quick start below, or open examples/ for runnable scripts (runtimes, templates) |
Docs: docs.gravixlayer.ai · Examples index: examples/README.md
Install
pip install gravixlayer
Configure
export GRAVIXLAYER_API_KEY="your-api-key"
export GRAVIXLAYER_CLOUD="azure" # default
export GRAVIXLAYER_REGION="eastus2" # default
Or pass options to the client:
from gravixlayer import GravixLayer
client = GravixLayer(
api_key="your-api-key",
base_url="https://api.gravixlayer.ai",
cloud="azure",
region="eastus2",
)
Quick start
from gravixlayer import GravixLayer
client = GravixLayer()
runtime = client.runtime.create(template="base-small")
# Run Python code
result = runtime.run_code(code="print('Hello from Gravix Layer')")
print(result.text)
# Run a shell command
runtime.run_cmd(command="pip install pandas --quiet")
runtime.run_cmd(command="pip", args=["install", "pandas", "--quiet"])
runtime.kill()
File operations
runtime = client.runtime.create(template="base-small")
runtime.file.write("/workspace/note.txt", "hello\n")
text = runtime.file.read("/workspace/out.txt").content
runtime.kill()
See examples/runtimes/07_file_operations.py for a full walkthrough.
Examples (runnable)
| Area | What you’ll learn |
|---|---|
| examples/runtimes/ | Create runtimes, run code & shell, files, metrics, SSH, Git, PTY, snapshots — 25 scripts |
| examples/templates/ | Build custom templates (Docker image, Git, Dockerfile) — 6 scripts |
Start here: examples/README.md (task table + quick reference).
Performance note (connections and HTTP/2)
The client uses HTTP/1.1 by default for predictable latency on typical API usage.
- Warm the connection before creating many runtimes: call
client.warmup()once (or usewarmup_on_init=Truewhen constructing the client). That pays TCP, TLS, and protocol setup up front so the first real request is cheaper. - HTTP/2: pass
http2=Trueto theGravixLayerclient constructor if you want multiplexing over a single established connection after TLS (useful for high concurrency). Requires thehttpx[http2]extra (already declared by this package).
Sync:
from gravixlayer import GravixLayer
client = GravixLayer(http2=True)
client.warmup()
# or: GravixLayer(http2=True, warmup_on_init=True)
Async: pass http2=True to AsyncGravixLayer and call await client.warmup() before heavy traffic.
from gravixlayer import AsyncGravixLayer
async with AsyncGravixLayer(http2=True) as client:
await client.warmup()
Async
import asyncio
from gravixlayer import AsyncGravixLayer
async def main():
async with AsyncGravixLayer() as client:
runtime = await client.runtime.create(template="base-small")
await client.runtime.kill(runtime.runtime_id)
asyncio.run(main())
Development
For local development and CI, run the unit tests (HTTP mocked; no API key required):
pip install -e ".[test]"
pytest tests/unit_tests
Test layout (tests/unit_tests vs tests/integration_tests), integration runs, and markers are documented in tests/README.md so this file stays focused on SDK usage.
Documentation and support
- Examples: examples/README.md
- Documentation: docs.gravixlayer.ai
- Issues: GitHub Issues
Feedback: gravixlayer/gravixlayer-feedback — bugs, features, and product feedback.
License
Apache License 2.0 — see LICENSE.
Copyright 2026 Gravix Layer.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file gravixlayer-0.1.81.tar.gz.
File metadata
- Download URL: gravixlayer-0.1.81.tar.gz
- Upload date:
- Size: 321.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d04d35e26796ef134b5bbf16a15a2277ba2a0ea52bc7228a76755b449799a3df
|
|
| MD5 |
b259ac881ea88b0270dff879815dbef2
|
|
| BLAKE2b-256 |
1ee5a5e8108eeac39bb15bd17132c529ce2764e8cd54aac3bb4c7db1ce2da7a9
|
File details
Details for the file gravixlayer-0.1.81-py3-none-any.whl.
File metadata
- Download URL: gravixlayer-0.1.81-py3-none-any.whl
- Upload date:
- Size: 160.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ed461313b2a2ad703cc2b126419c0f1b8be95e1c78b2678c56ef3c1f39943f0f
|
|
| MD5 |
1a04ce693553af9951bc97c4ae2ea90f
|
|
| BLAKE2b-256 |
62fba433be2d90d5f98f6a378bda5a0e0a56ac9f03e800d862bbb5c69c982498
|
