elapi 2.0.2__tar.gz → 2.2.0__tar.gz

{elapi-2.0.2 → elapi-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: elapi
-Version: 2.0.2
+Version: 2.2.0
 Summary: elAPI is a powerful, extensible API client for eLabFTW.
 Home-page: https://www.urz.uni-heidelberg.de/en/service-catalogue/software-and-applications/elabftw
 License: AGPL-3.0-only
@@ -22,6 +22,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: System :: Systems Administration
@@ -32,25 +33,37 @@ Requires-Dist: h2 (>=4.1.0,<5.0.0)
 Requires-Dist: httpx (>=0.24.1,<0.25.0)
 Requires-Dist: httpx-auth (>=0.17.0,<0.18.0)
 Requires-Dist: mistune (>=3.0.2,<4.0.0)
-Requires-Dist: python-dateutil (>=2.8.2,<3.0.0) ; extra == "uhd-urz"
+Requires-Dist: python-dateutil (>=2.9.0.post0,<3.0.0) ; extra == "uhd-urz"
 Requires-Dist: pyyaml (>=6.0.1,<7.0.0)
-Requires-Dist: tenacity (>=8.2.3,<9.0.0) ; extra == "uhd-urz"
+Requires-Dist: rich (>=13.8.0,<14.0.0)
+Requires-Dist: tenacity (>=9.0.0,<10.0.0) ; extra == "uhd-urz"
 Requires-Dist: typer[all] (>=0.9.0,<0.10.0)
+Requires-Dist: uvloop (>=0.20.0,<0.21.0) ; extra == "uhd-urz"
 Project-URL: Repository, https://github.com/uhd-urz/elAPI/
 Description-Content-Type: text/markdown
 
-# elAPI
-
-[![Package version](https://badge.fury.io/py/elapi.svg/?branch=main)](https://pypi.org/project/elapi)
-
-elAPI is a powerful, extensible API client for eLabFTW developed at
+<p align="center">
+<img src="https://heibox.uni-heidelberg.de/f/43bdc63b9458478e949f/?dl=1" alt="elAPI logo" width=120 />
+</p>
+
+<p align="center">
+   <a href="https://pypi.org/project/elapi">
+<img alt="Package version" src="https://badge.fury.io/py/elapi.svg/?branch=main" />
+   </a>
+<a href="#compatibility">
+   <img alt="Static Badge" src="https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12-%230d7dbe">
+   <img alt="Static Badge" src="https://img.shields.io/badge/eLabFTW%20support-4.5%2B%20%7C%205.0%20%7C%205.1-%2323b3be">
+</a>
+</p>
+
+elAPI is a powerful, extensible API client for [eLabFTW](https://www.elabftw.net/) developed at
 the [University Computing Centre](https://www.urz.uni-heidelberg.de/en)
 (URZ, [FIRE](https://www.urz.uni-heidelberg.de/en/node/64/organisation/future-it-research-education) division) of
-[University of Heidelberg](https://www.uni-heidelberg.de/en). It supports serving all kinds of requests documented on
+[University of Heidelberg](https://www.uni-heidelberg.de/en). It supports serving all kinds of requests documented in
 [eLabFTW API documentation](https://doc.elabftw.net/api/v2/) with ease. elAPI provides a simple interface via its CLI
 executable, and numerous advanced APIs when it is used directly as a Python package.
 
-<img src="./.assets/elapi_features.svg" alt="elAPI features in a nutshell" />
+<img src="https://heibox.uni-heidelberg.de/f/7714c7eeb0f54a3ba318/?dl=1" alt="elAPI features in a nutshell" />
 
 **Example:**
 
@@ -70,16 +83,6 @@ local `~/Downloads/` folder.
 
 ## Installation
 
-elAPI can be used both as a CLI tool and as a Python library. If you are interested in simply using elAPI's
-off-the-shelf features from the command-line, install elAPI as a CLI tool. If you intend to write automation script for
-eLabFTW, you should install elAPI as a library inside a virtual environment. Of course, if you're interested in
-both, you can have elAPI installed in both ways.
-
-### Install elAPI as a CLI tool
-
-Support for installing Python packages with `pip install --user` has been deprecated with the adoption
-of [PEP 688](https://peps.python.org/pep-0668/) on many systems
-like [Debian 12](https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1030335#5).
 We recommend [`pipx`](https://pipx.pypa.io/stable/) for installing elAPI for use of its CLI functionalities. Pipx
 installs packages in isolated virtual environments, so Pipx-installed elAPI should not conflict with elAPI installed
 inside other virtual environments.
@@ -89,24 +92,52 @@ $ pipx install elapi
 ```
 
 After installation with Pipx is complete, you would also be able to run elAPI just by entering the `elapi` command on
-the
-terminal.
+the terminal. You can move on to ["Getting started"](#getting-started).
+
+### Advanced installation
+
+elAPI can be used both as a CLI tool and as a Python library. If you are interested in simply using elAPI's
+off-the-shelf features from the command-line, install elAPI as a CLI tool (see ["Installation"](#installation)). If you
+intend to write automation script for eLabFTW, you should install elAPI as a library inside a virtual environment. Of
+course, if you're interested in both, you can have elAPI installed in both ways.
+
+> [!NOTE]
+> Support for installing Python packages with `pip install --user` has been deprecated with the adoption
+> of [PEP 688](https://peps.python.org/pep-0668/) on many systems
+> like [Debian 12](https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1030335#5).
 
-### Install elAPI as a library
+### Installing elAPI as a library
 
-It is recommended to install elAPI inside a Python virtual environment for use of its rich APIs for
+It is recommended to install elAPI inside a Python virtual environment with your preferred package manager (`pip`,
+`poetry`, `pipenv`, `rye`, `uv`, etc.) for use of its rich APIs for
 working with eLabFTW. From inside a virtual environment, elAPI CLI can be invoked with `python -m elapi.cli`.
 At the moment, though, the documentation about using elAPI as a library is severely lacking.
 
-## Configuration
+## Getting started
 
-elAPI needs to be configured first before you can do anything useful with it. Mainly, elAPI needs to know your eLabFTW
-server's API URL and your API key (or token) for access.
+Once you have elAPI [installed](#installation), to **quickly** get started, run `elapi init`. You will be prompted with
+questions about your eLabFTW server with examples to help you fill in the answers. Here's a demo:
+
+```shell
+$ elapi init
+```
+
+<video src='https://github.com/user-attachments/assets/8d5f69ed-b644-4d75-b816-d06d4e937105'> </video>
+<p align="center">elapi init demo</p>
 
-### Quick configuration
+That's all! Run [`elapi show-config`](#show-config) to view your configuration details.
 
-You can run `elapi init` to simplify the configuration process. You will be prompted with questions
-about your eLabFTW server with examples to help you fill in the answers.
+## Compatibility
+
+elAPI is compatible with the following Python versions: `3.9`, `3.10`, `3.11`, `3.12`. elAPI supports
+the [eLabFTW REST API v2](https://doc.elabftw.net/api/v2/), and can be used with the following eLabFTW
+versions: `4.5`, `4.6`, `4.7`, `4.8`, `4.9`, `4.10`, `5.0`, `5.1`.
+
+## Configuration
+
+elAPI needs to be configured first before you can do anything useful with it. Mainly, elAPI needs to know your eLabFTW
+server's API URL and your API key (or token) for access. See quick configuration method
+in "[Getting started](#getting-started)" before you dive into the advanced settings.
 
 ### Advanced configuration
 
@@ -141,14 +172,17 @@ verify_ssl: true
 timeout: 90
 ```
 
-`export_dir` is where elAPI will export response content to if no path is provided to `--export/-E`.
-When `unsafe_api_token_warning` is `True`, elAPI will show a warning if you're storing `elapi.yml` in the current
-working directory, as it typically happens that developers accidentally commit and push configuration files with
-secrets. `enable_http2` enables HTTP/2 protocol support which by default is turned off. Be aware
-of [known issues](https://github.com/encode/httpx/discussions/2112) with
-HTTP/2 if you are making async requests with heavy load. `verify_ssl` can be turned off with `False` if you are trying
-out a development server that doesn't provide a valid SSL certificate. `timeout` can be modified to your needs. E.g., a
-poor internet connection might benefit from a higher timeout number. THe default timeout is `90` seconds.
+- `export_dir` is where elAPI will export response content to if no path is explicitly provided to `--export/-E`.
+- When `unsafe_api_token_warning` is `True`, elAPI will show a warning if you're storing `elapi.yml` in the current
+  working directory, as it typically happens that developers accidentally commit and push configuration files with
+  secrets.
+- `enable_http2` enables HTTP/2 protocol support which by default is turned off. Be aware
+  of [known issues](https://github.com/encode/httpx/discussions/2112) with HTTP/2 if you are making async requests with
+  a heavy load.
+- `verify_ssl` can be turned off with value `False` if you are
+  trying out a development server that doesn't provide a valid SSL certificate.
+- `timeout` can be modified to your needs. E.g., a poor internet connection might benefit from a higher timeout number.
+  The default timeout is `90` seconds.
 
 ### `show-config`
 
@@ -156,36 +190,14 @@ You can get an overview of detected configuration with `elapi show-config`. `sho
 which configuration values are actually used by elAPI, if you are working with multiple configuration files.
 
 ```shell
-$ elapi show-config
-
-elapi configuration information
-
-The following debug information includes configuration values and their sources as detected by elapi.
-
-▌ Name [Key]: Value ← Source
-
-• Log file path: /Users/ <username >/.local/share/elapi/elapi.log
-• Host address [host]: https://demo.elabftw.net/api/v2 ← USER LEVEL
-• API Token [api_token]: 00-55******55555 ← USER LEVEL
-• Export directory [export_dir]: /Users/ ← USER LEVEL <username >/Downloads/elapi
-• App data directory: /Users/ <username >/.local/share/elapi
-• Third-party plugins directory: /Users/ <username >/.local/share/elapi/plugins
-• Caching directory: /private/var/tmp/elapi
-• Unsafe API token use warning [unsafe_api_token_warning]: True ← USER LEVEL
-• Enable HTTP/2 [enable_http2]: False ← USER LEVEL
-• Verify SSL certificate [verify_ssl]: True ← USER LEVEL
-• Timeout duration [timeout]: 90.0 seconds ← USER LEVEL
-• Development mode [development_mode]: False ← USER LEVEL
-
-Detected configuration sources that are in use:
-
-• USER LEVEL: /Users/ <username >/.config/elapi.yml
-
+$ elapi show-config  # system username: "culdesac" 
 ```
 
+![elAPI show-config output](https://heibox.uni-heidelberg.de/f/00a8dabbf2124087aae4/?dl=1)
+
 If both `host` and `api_token` are detected, you are good to go!
 
-### Override configuration
+### Overriding configuration
 
 elAPI now supports `--override/--OC` as a global option that can be used to override the configuration parameters
 as detected by `elapi show-cofig`. All plugins will also automatically listen to the overridden configuration. This can
@@ -215,6 +227,13 @@ You can request a list o all active experiments and export it to a `JSON` file.
 $ elapi get experiments --export ~/Downoads/experiments.json
 ```
 
+Enable built-in syntax highlighting with `--highlight` or `-H`. Here, the following command will fetch team information
+of team with team ID 1.
+
+```shell
+$ elapi get -H teams --id 1
+```
+
 ### `POST` requests
 
 Create a new user by the name 'John Doe':
@@ -258,7 +277,7 @@ You can reset the configuration to default values.
 $ elapi delete config
 ```
 
-### `experiments` plugin
+### `experiments` built-in plugin
 
 `experiments` plugin enables experiments-specific actions. You can download an experiment in PDF by its "Unique eLabID"
 to `~/Downloads` directory.
@@ -279,7 +298,7 @@ You can also upload an attachment to an experiment.
 $ elapi experiments upload-attachment --id <experiment ID> --path <path to attachment file> --comment <comment for your attachment>
 ```
 
-### Plugins
+## Creating a plugin
 
 elAPI has seamless support with tight-integration for third-party plugins. A simple third-party plugin can be created in
 a few easy steps:
@@ -306,7 +325,7 @@ you want to create a plugin metadata file `elapi_plugin_metadata.yml` (notice on
 define the virtual environment that your plugin specifically requires.
 
 ```python
-import requests
+import requests  # A third-party dependency
 
 from elapi.api import GETRequest
 from elapi.plugins.commons import Typer
@@ -330,8 +349,14 @@ def wiki_status():
 And the path to virtual environment will be defined in the metadata file:
 
 ```yaml
-plugin_name: test
-cli_script: ./cli.py  # Path to the cli.py script
-venv_dir: ./.venv  # Path to the virtual environment
+# elapi_plugin_metadata.yml
+plugin_name: awesome
+cli_script: ~/awesome/cli.py  # Path to the cli.py script
+venv_dir: ~/awesome/.venv  # Path to the virtual environment
+project_dir: ~/awesome  # Path to the project root directory where the plugin is located
 ```
 
+This metadata file of plugin `awesome` must be placed inside `~/.local/share/elapi/plugins/awesome`. Notice, the plugin
+name must also match the parent directory name of `elapi_plugin_metadata.yml`. This way we ensure a plugin name remains
+unique.
+

{elapi-2.0.2 → elapi-2.2.0}/README.md

@@ -1,15 +1,25 @@
-# elAPI
-
-[![Package version](https://badge.fury.io/py/elapi.svg/?branch=main)](https://pypi.org/project/elapi)
-
-elAPI is a powerful, extensible API client for eLabFTW developed at
+<p align="center">
+<img src="https://heibox.uni-heidelberg.de/f/43bdc63b9458478e949f/?dl=1" alt="elAPI logo" width=120 />
+</p>
+
+<p align="center">
+   <a href="https://pypi.org/project/elapi">
+<img alt="Package version" src="https://badge.fury.io/py/elapi.svg/?branch=main" />
+   </a>
+<a href="#compatibility">
+   <img alt="Static Badge" src="https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12-%230d7dbe">
+   <img alt="Static Badge" src="https://img.shields.io/badge/eLabFTW%20support-4.5%2B%20%7C%205.0%20%7C%205.1-%2323b3be">
+</a>
+</p>
+
+elAPI is a powerful, extensible API client for [eLabFTW](https://www.elabftw.net/) developed at
 the [University Computing Centre](https://www.urz.uni-heidelberg.de/en)
 (URZ, [FIRE](https://www.urz.uni-heidelberg.de/en/node/64/organisation/future-it-research-education) division) of
-[University of Heidelberg](https://www.uni-heidelberg.de/en). It supports serving all kinds of requests documented on
+[University of Heidelberg](https://www.uni-heidelberg.de/en). It supports serving all kinds of requests documented in
 [eLabFTW API documentation](https://doc.elabftw.net/api/v2/) with ease. elAPI provides a simple interface via its CLI
 executable, and numerous advanced APIs when it is used directly as a Python package.
 
-<img src="./.assets/elapi_features.svg" alt="elAPI features in a nutshell" />
+<img src="https://heibox.uni-heidelberg.de/f/7714c7eeb0f54a3ba318/?dl=1" alt="elAPI features in a nutshell" />
 
 **Example:**
 
@@ -29,16 +39,6 @@ local `~/Downloads/` folder.
 
 ## Installation
 
-elAPI can be used both as a CLI tool and as a Python library. If you are interested in simply using elAPI's
-off-the-shelf features from the command-line, install elAPI as a CLI tool. If you intend to write automation script for
-eLabFTW, you should install elAPI as a library inside a virtual environment. Of course, if you're interested in
-both, you can have elAPI installed in both ways.
-
-### Install elAPI as a CLI tool
-
-Support for installing Python packages with `pip install --user` has been deprecated with the adoption
-of [PEP 688](https://peps.python.org/pep-0668/) on many systems
-like [Debian 12](https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1030335#5).
 We recommend [`pipx`](https://pipx.pypa.io/stable/) for installing elAPI for use of its CLI functionalities. Pipx
 installs packages in isolated virtual environments, so Pipx-installed elAPI should not conflict with elAPI installed
 inside other virtual environments.
@@ -48,24 +48,52 @@ $ pipx install elapi
 ```
 
 After installation with Pipx is complete, you would also be able to run elAPI just by entering the `elapi` command on
-the
-terminal.
+the terminal. You can move on to ["Getting started"](#getting-started).
+
+### Advanced installation
+
+elAPI can be used both as a CLI tool and as a Python library. If you are interested in simply using elAPI's
+off-the-shelf features from the command-line, install elAPI as a CLI tool (see ["Installation"](#installation)). If you
+intend to write automation script for eLabFTW, you should install elAPI as a library inside a virtual environment. Of
+course, if you're interested in both, you can have elAPI installed in both ways.
+
+> [!NOTE]
+> Support for installing Python packages with `pip install --user` has been deprecated with the adoption
+> of [PEP 688](https://peps.python.org/pep-0668/) on many systems
+> like [Debian 12](https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1030335#5).
 
-### Install elAPI as a library
+### Installing elAPI as a library
 
-It is recommended to install elAPI inside a Python virtual environment for use of its rich APIs for
+It is recommended to install elAPI inside a Python virtual environment with your preferred package manager (`pip`,
+`poetry`, `pipenv`, `rye`, `uv`, etc.) for use of its rich APIs for
 working with eLabFTW. From inside a virtual environment, elAPI CLI can be invoked with `python -m elapi.cli`.
 At the moment, though, the documentation about using elAPI as a library is severely lacking.
 
-## Configuration
+## Getting started
 
-elAPI needs to be configured first before you can do anything useful with it. Mainly, elAPI needs to know your eLabFTW
-server's API URL and your API key (or token) for access.
+Once you have elAPI [installed](#installation), to **quickly** get started, run `elapi init`. You will be prompted with
+questions about your eLabFTW server with examples to help you fill in the answers. Here's a demo:
+
+```shell
+$ elapi init
+```
+
+<video src='https://github.com/user-attachments/assets/8d5f69ed-b644-4d75-b816-d06d4e937105'> </video>
+<p align="center">elapi init demo</p>
 
-### Quick configuration
+That's all! Run [`elapi show-config`](#show-config) to view your configuration details.
 
-You can run `elapi init` to simplify the configuration process. You will be prompted with questions
-about your eLabFTW server with examples to help you fill in the answers.
+## Compatibility
+
+elAPI is compatible with the following Python versions: `3.9`, `3.10`, `3.11`, `3.12`. elAPI supports
+the [eLabFTW REST API v2](https://doc.elabftw.net/api/v2/), and can be used with the following eLabFTW
+versions: `4.5`, `4.6`, `4.7`, `4.8`, `4.9`, `4.10`, `5.0`, `5.1`.
+
+## Configuration
+
+elAPI needs to be configured first before you can do anything useful with it. Mainly, elAPI needs to know your eLabFTW
+server's API URL and your API key (or token) for access. See quick configuration method
+in "[Getting started](#getting-started)" before you dive into the advanced settings.
 
 ### Advanced configuration
 
@@ -100,14 +128,17 @@ verify_ssl: true
 timeout: 90
 ```
 
-`export_dir` is where elAPI will export response content to if no path is provided to `--export/-E`.
-When `unsafe_api_token_warning` is `True`, elAPI will show a warning if you're storing `elapi.yml` in the current
-working directory, as it typically happens that developers accidentally commit and push configuration files with
-secrets. `enable_http2` enables HTTP/2 protocol support which by default is turned off. Be aware
-of [known issues](https://github.com/encode/httpx/discussions/2112) with
-HTTP/2 if you are making async requests with heavy load. `verify_ssl` can be turned off with `False` if you are trying
-out a development server that doesn't provide a valid SSL certificate. `timeout` can be modified to your needs. E.g., a
-poor internet connection might benefit from a higher timeout number. THe default timeout is `90` seconds.
+- `export_dir` is where elAPI will export response content to if no path is explicitly provided to `--export/-E`.
+- When `unsafe_api_token_warning` is `True`, elAPI will show a warning if you're storing `elapi.yml` in the current
+  working directory, as it typically happens that developers accidentally commit and push configuration files with
+  secrets.
+- `enable_http2` enables HTTP/2 protocol support which by default is turned off. Be aware
+  of [known issues](https://github.com/encode/httpx/discussions/2112) with HTTP/2 if you are making async requests with
+  a heavy load.
+- `verify_ssl` can be turned off with value `False` if you are
+  trying out a development server that doesn't provide a valid SSL certificate.
+- `timeout` can be modified to your needs. E.g., a poor internet connection might benefit from a higher timeout number.
+  The default timeout is `90` seconds.
 
 ### `show-config`
 
@@ -115,36 +146,14 @@ You can get an overview of detected configuration with `elapi show-config`. `sho
 which configuration values are actually used by elAPI, if you are working with multiple configuration files.
 
 ```shell
-$ elapi show-config
-
-elapi configuration information
-
-The following debug information includes configuration values and their sources as detected by elapi.
-
-▌ Name [Key]: Value ← Source
-
-• Log file path: /Users/ <username >/.local/share/elapi/elapi.log
-• Host address [host]: https://demo.elabftw.net/api/v2 ← USER LEVEL
-• API Token [api_token]: 00-55******55555 ← USER LEVEL
-• Export directory [export_dir]: /Users/ ← USER LEVEL <username >/Downloads/elapi
-• App data directory: /Users/ <username >/.local/share/elapi
-• Third-party plugins directory: /Users/ <username >/.local/share/elapi/plugins
-• Caching directory: /private/var/tmp/elapi
-• Unsafe API token use warning [unsafe_api_token_warning]: True ← USER LEVEL
-• Enable HTTP/2 [enable_http2]: False ← USER LEVEL
-• Verify SSL certificate [verify_ssl]: True ← USER LEVEL
-• Timeout duration [timeout]: 90.0 seconds ← USER LEVEL
-• Development mode [development_mode]: False ← USER LEVEL
-
-Detected configuration sources that are in use:
-
-• USER LEVEL: /Users/ <username >/.config/elapi.yml
-
+$ elapi show-config  # system username: "culdesac" 
 ```
 
+![elAPI show-config output](https://heibox.uni-heidelberg.de/f/00a8dabbf2124087aae4/?dl=1)
+
 If both `host` and `api_token` are detected, you are good to go!
 
-### Override configuration
+### Overriding configuration
 
 elAPI now supports `--override/--OC` as a global option that can be used to override the configuration parameters
 as detected by `elapi show-cofig`. All plugins will also automatically listen to the overridden configuration. This can
@@ -174,6 +183,13 @@ You can request a list o all active experiments and export it to a `JSON` file.
 $ elapi get experiments --export ~/Downoads/experiments.json
 ```
 
+Enable built-in syntax highlighting with `--highlight` or `-H`. Here, the following command will fetch team information
+of team with team ID 1.
+
+```shell
+$ elapi get -H teams --id 1
+```
+
 ### `POST` requests
 
 Create a new user by the name 'John Doe':
@@ -217,7 +233,7 @@ You can reset the configuration to default values.
 $ elapi delete config
 ```
 
-### `experiments` plugin
+### `experiments` built-in plugin
 
 `experiments` plugin enables experiments-specific actions. You can download an experiment in PDF by its "Unique eLabID"
 to `~/Downloads` directory.
@@ -238,7 +254,7 @@ You can also upload an attachment to an experiment.
 $ elapi experiments upload-attachment --id <experiment ID> --path <path to attachment file> --comment <comment for your attachment>
 ```
 
-### Plugins
+## Creating a plugin
 
 elAPI has seamless support with tight-integration for third-party plugins. A simple third-party plugin can be created in
 a few easy steps:
@@ -265,7 +281,7 @@ you want to create a plugin metadata file `elapi_plugin_metadata.yml` (notice on
 define the virtual environment that your plugin specifically requires.
 
 ```python
-import requests
+import requests  # A third-party dependency
 
 from elapi.api import GETRequest
 from elapi.plugins.commons import Typer
@@ -289,7 +305,13 @@ def wiki_status():
 And the path to virtual environment will be defined in the metadata file:
 
 ```yaml
-plugin_name: test
-cli_script: ./cli.py  # Path to the cli.py script
-venv_dir: ./.venv  # Path to the virtual environment
+# elapi_plugin_metadata.yml
+plugin_name: awesome
+cli_script: ~/awesome/cli.py  # Path to the cli.py script
+venv_dir: ~/awesome/.venv  # Path to the virtual environment
+project_dir: ~/awesome  # Path to the project root directory where the plugin is located
 ```
+
+This metadata file of plugin `awesome` must be placed inside `~/.local/share/elapi/plugins/awesome`. Notice, the plugin
+name must also match the parent directory name of `elapi_plugin_metadata.yml`. This way we ensure a plugin name remains
+unique.

{elapi-2.0.2 → elapi-2.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "elapi"
-version = "2.0.2"
+version = "2.2.0"
 description = "elAPI is a powerful, extensible API client for eLabFTW."
 authors = [
     "Alexander Haller, Mahadi Xion <elabftw@uni-heidelberg.de>",
@@ -38,15 +38,17 @@ python = "^3.9.0"
 dynaconf = "^3.2.0"
 httpx = "^0.24.1"
 httpx-auth = "^0.17.0"
+rich = "^13.8.0" # typer already depends on rich. We define rich here to use the latest version of rich
 typer = { extras = ["all"], version = "^0.9.0" }
 pyyaml = "^6.0.1"
 mistune = "^3.0.2"
 h2 = "^4.1.0"
-python-dateutil = { version = "^2.8.2", optional = true }
-tenacity = { version = "^8.2.3", optional = true }
+tenacity = { version = "^9.0.0", optional = true }
+python-dateutil = { version = "^2.9.0.post0", optional = true }
+uvloop = { version = "^0.20.0", optional = true }
 
 [tool.poetry.extras]
-uhd-urz = ["python-dateutil", "tenacity"]
+uhd-urz = ["python-dateutil", "tenacity", "uvloop"]
 
 [tool.poetry.group.dev.dependencies]
 ptpython = "^3.0.23"

elapi-2.2.0/src/elapi/VERSION

@@ -0,0 +1 @@
+2.2.0

elapi-2.2.0/src/elapi/__init__.py

@@ -0,0 +1,2 @@
+# ruff: noqa: F401
+from ._names import APP_NAME, APP_BRAND_NAME

{elapi-2.0.2 → elapi-2.2.0}/src/elapi/_names.py

@@ -10,9 +10,16 @@ LOG_FILE_NAME: str = f"{APP_NAME}.log"
 CONFIG_FILE_EXTENSION: str = "yml"
 CONFIG_FILE_NAME: str = f"{APP_NAME}.{CONFIG_FILE_EXTENSION}"
 DEFAULT_EXPORT_DATA_FORMAT: str = "json"
+VERSION_FILE_NAME: str = "VERSION"
 user_home: Path = Path.home()
 cur_dir: Path = Path.cwd()
 
+# eLabFTW specific definitions
+ELAB_NAME: str = "elabftw"
+ELAB_BRAND_NAME: str = "eLabFTW"
+ELAB_API_EXPECTED_VERSION: int = 2
+ELAB_HOST_URL_API_SUFFIX: str = f"/api/v{ELAB_API_EXPECTED_VERSION}"
+
 # reference for the following directory conventions:
 # https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html
 
@@ -44,6 +51,7 @@ KEY_ENABLE_HTTP2: str = "ENABLE_HTTP2"
 KEY_VERIFY_SSL: str = "VERIFY_SSL"
 KEY_TIMEOUT: str = "TIMEOUT"
 KEY_DEVELOPMENT_MODE: str = "DEVELOPMENT_MODE"
+KEY_PLUGIN_KEY_NAME: str = "PLUGINS"
 
 # Log data directory with root permission
 LOG_DIR_ROOT: Path = Path(f"/var/log/{APP_NAME}")

{elapi-2.0.2 → elapi-2.2.0}/src/elapi/api/__init__.py

@@ -1,5 +1,8 @@
 # ruff: noqa: F401
 from .api import (
+    SessionDefaults,
+    SimpleClient,
+    GlobalSharedSession,
     APIRequest,
     ElabFTWURLError,
     ElabFTWURL,