From 24b29bf169d9859b8799f54799c1257c3d563043 Mon Sep 17 00:00:00 2001 From: pbrassel <52356233+pbrassel@users.noreply.github.com> Date: Tue, 25 Nov 2025 11:00:55 +0100 Subject: [PATCH 1/2] docs: update link due to renaming the repo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index dc52e1b..6206561 100644 --- a/README.md +++ b/README.md @@ -104,4 +104,4 @@ 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](https://privateaim.github.io/flame-hub-client/) which methods are available. +[documentation](https://privateaim.github.io/hub-python-client/) which methods are available. From 87a041ec5aecf42ad9dea2598274dca508e24998 Mon Sep 17 00:00:00 2001 From: pbrassel <52356233+pbrassel@users.noreply.github.com> Date: Tue, 25 Nov 2025 11:08:26 +0100 Subject: [PATCH 2/2] docs: change name to FLAME Hub Python Client --- README.md | 6 +++--- docs/conf.py | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6206561..cd7f567 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# FLAME Hub Client +# FLAME Hub Python Client -The FLAME Hub Client is a Python Client which wraps the endpoints of [FLAME Hub](https://github.com/PrivateAIM/hub) +The FLAME Hub Python Client is a client which wraps the endpoints of [FLAME Hub](https://github.com/PrivateAIM/hub) API. This repository is part of the [PrivateAIM](https://privateaim.de/eng/index.html) project. ## Getting started @@ -13,7 +13,7 @@ python -m pip install flame-hub-client ## Quickstart -The FLAME Hub Client offers *get*, *find*, *update*, *create* and *delete* methods for the core, storage and auth +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 robot 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. diff --git a/docs/conf.py b/docs/conf.py index 7ce6233..ce6a0b7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -15,7 +15,7 @@ # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information -project = "FLAME Hub Client" +project = "FLAME Hub Python Client" copyright = "2025, Paul Brassel, Maximilian Jugl" author = "Paul Brassel, Maximilian Jugl" version = __version__