Code Coverage Python versions

FLAME Hub Python Client

The FLAME Hub Python Client is a client which wraps the endpoints of FLAME Hub API. This repository is part of the PrivateAIM project.

Getting started

To install the client, Python 3.10 or higher is required.

python -m pip install flame-hub-client

Quickstart

The FLAME Hub Python Client offers get, find, update, create and delete methods for the core, storage and auth endpoints. It is capable of authenticating against the API using either password or client authentication. Pick one, provide your credentials and plug them into the class for the service you want to use. Note that the client will automatically reauthenticate if necessary.

import flame_hub

auth = flame_hub.auth.PasswordAuth(
    username="admin", password="start123", base_url="http://localhost:3000/auth/"
)
auth_client = flame_hub.AuthClient(base_url="http://localhost:3000/auth/", auth=auth)

Now you're ready to use the library's functions! Start off with getting the so-called master realm by using one of the find methods and filtering for the name "master".

master_realms = auth_client.find_realms(filter={"name": "master"})

Every find method returns a list of matching resources. Since there is only one realm called "master" in this example, we simply pop it from the list and print the result.

assert len(master_realms) == 1
master_realm = master_realms.pop()

print(master_realm.model_dump_json(indent=2))

{
  "name": "master",
  "displayName": null,
  "description": null,
  "id": "794f2375-f043-4789-bd0c-e5534e8deeaa",
  "builtIn": true,
  "createdAt": "2025-05-12T09:44:08.284000Z",
  "updatedAt": "2025-05-12T09:44:08.284000Z"
}

Next we want to create a new node. Node resources are accessible over endpoints under the core directive. So the first step is to create a new core client and then create a new node.

core_client = flame_hub.CoreClient(base_url="http://localhost:3000/core/", auth=auth)
my_node = core_client.create_node(name="my-node", realm_id=master_realm)

print(my_node.model_dump_json(indent=2))

{
  "externalName": null,
  "hidden": false,
  "name": "my-node",
  "realmId": "794f2375-f043-4789-bd0c-e5534e8deeaa",
  "registryId": null,
  "type": "default",
  "id": "03636152-e6a8-4e01-994e-18b2b0c3a935",
  "publicKey": null,
  "online": false,
  "registry": null,
  "registryProjectId": null,
  "registryProject": null,
  "robotId": null,
  "clientId": "2d3e19b4-6708-4279-b2a7-34ad42638e4b",
  "createdAt": "2025-05-19T15:43:57.859000Z",
  "updatedAt": "2025-05-19T15:43:57.859000Z"
}

Maybe making the node public wasn't such a good idea, so let's update it by hiding it. To see if the update was successful, we have to request the updated node from the Hub.

core_client.update_node(my_node, hidden=True)

assert core_client.get_node(my_node.id) is True

To clean up our mess, we delete the node and verify that the node is gone forever.

core_client.delete_node(my_node)

assert core_client.get_node(my_node.id) is None

Note that not all method types are implemented for each resource. Check out the documentation to see which methods are available.

Download files

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

Source Distribution

flame_hub_client-0.5.1.tar.gz (27.6 kB view details)

Uploaded Aug 3, 2026 Source

Built Distribution

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

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

flame_hub_client-0.5.1-py3-none-any.whl (30.1 kB view details)

Uploaded Aug 3, 2026 Python 3

File details

Details for the file flame_hub_client-0.5.1.tar.gz.

File metadata

Download URL: flame_hub_client-0.5.1.tar.gz
Upload date: Aug 3, 2026
Size: 27.6 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for flame_hub_client-0.5.1.tar.gz
Algorithm	Hash digest
SHA256	`93b7da0ce6c9da707870eb012fad50736c8fcde84d17fb97b76b3fc2a9ecdb5f`
MD5	`f013284efcfe26bd5edebf18466998c0`
BLAKE2b-256	`f61ac8bf7c563414969d7492e7e439256fa0fd3442d1bd10345a60ed7ddb3870`

See more details on using hashes here.

Provenance

The following attestation bundles were made for flame_hub_client-0.5.1.tar.gz:

Publisher: release.yml on PrivateAIM/hub-python-client

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: flame_hub_client-0.5.1.tar.gz
- Subject digest: 93b7da0ce6c9da707870eb012fad50736c8fcde84d17fb97b76b3fc2a9ecdb5f
- Sigstore transparency entry: 2334882805
- Sigstore integration time: Aug 3, 2026
Source repository:
- Permalink: PrivateAIM/hub-python-client@d88d5042913dff2c16a8e2a8521405662f67c428
- Branch / Tag: refs/heads/main
- Owner: https://github.com/PrivateAIM
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yml@d88d5042913dff2c16a8e2a8521405662f67c428
- Trigger Event: push