Skip to content

Rename repo #86

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pbrassel merged 2 commits into from
Nov 25, 2025
Merged

Rename repo #86

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
24b29bf
docs: update link due to renaming the repo
pbrassel Nov 25, 2025
87a041e
docs: change name to FLAME Hub Python Client
pbrassel Nov 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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.
Expand Down Expand Up @@ -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.
2 changes: 1 addition & 1 deletion docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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__
Expand Down