elapi 1.0.5__tar.gz → 1.0.7.dev1__tar.gz

{elapi-1.0.5 → elapi-1.0.7.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: elapi
-Version: 1.0.5
+Version: 1.0.7.dev1
 Summary: elAPI is a powerful, extensible API interface to eLabFTW built for the University Computing Centre (URZ, FIRE division) at Universität Heidelberg.
 Home-page: https://www.urz.uni-heidelberg.de/en/service-catalogue/software-and-applications/elabftw
 License: AGPL-3.0-only
@@ -29,6 +29,7 @@ Classifier: Topic :: Utilities
 Requires-Dist: dynaconf (>=3.2.0,<4.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)
 Requires-Dist: pyyaml (>=6.0.1,<7.0.0)
 Requires-Dist: tenacity (>=8.2.3,<9.0.0)
@@ -54,12 +55,15 @@ $ elapi get users --id <id>
 
 ## Installation
 
-elAPI can be installed from PyPI. Make sure `pip` is not invoked from an active virtual environment.
+Support for installing 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.
 
-```sh
-$ python3 -m pip install --user elapi
+```shell
+$ pipx install elapi
 ```
 
+Of course, `pip install --user elapi` might continue to work on some systems.
+
 ## Configuration
 
 elAPI needs to be configured first before we can do anything useful with it. elAPI supports a YAML configuration file in
@@ -126,7 +130,28 @@ $ elapi get experiments --export ~/Downoads/experiments.json
 We can create a new user by the name 'John Doe'.
 
 ```shell
-$ elapi post users -d '{"firstname": "John", "lastname": "Doe", "email": "test_test@itnerd.de"}'
+$ elapi post users --id <user id> -d '{"firstname": "John", "lastname": "Doe", "email": "test_test@itnerd.de"}'
+```
+
+### `PATCH` requests
+
+We can update an existing user's email address.
+
+```shell
+$ elapi patch users --id <user id> -d '{"email": "new_email@itnerd.de"}'
+```
+
+`patch` command allows us to make changes to eLabFTW server settings. E.g., we can update the time (in minutes)
+after which the authentication cookie will expire.
+
+```shell
+$ elapi patch config -d '{"cookie_validity_time": 43200}'
+```
+
+We can publish an announcement to all the members.
+
+```shell
+$ elapi patch config -d '{"announcement": "Notice: Server will be down tomorrow at midnight due to scheduled maintenance."}'
 ```
 
 ### Bill teams

{elapi-1.0.5 → elapi-1.0.7.dev1}/README.md

@@ -17,12 +17,15 @@ $ elapi get users --id <id>
 
 ## Installation
 
-elAPI can be installed from PyPI. Make sure `pip` is not invoked from an active virtual environment.
+Support for installing 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.
 
-```sh
-$ python3 -m pip install --user elapi
+```shell
+$ pipx install elapi
 ```
 
+Of course, `pip install --user elapi` might continue to work on some systems.
+
 ## Configuration
 
 elAPI needs to be configured first before we can do anything useful with it. elAPI supports a YAML configuration file in
@@ -89,7 +92,28 @@ $ elapi get experiments --export ~/Downoads/experiments.json
 We can create a new user by the name 'John Doe'.
 
 ```shell
-$ elapi post users -d '{"firstname": "John", "lastname": "Doe", "email": "test_test@itnerd.de"}'
+$ elapi post users --id <user id> -d '{"firstname": "John", "lastname": "Doe", "email": "test_test@itnerd.de"}'
+```
+
+### `PATCH` requests
+
+We can update an existing user's email address.
+
+```shell
+$ elapi patch users --id <user id> -d '{"email": "new_email@itnerd.de"}'
+```
+
+`patch` command allows us to make changes to eLabFTW server settings. E.g., we can update the time (in minutes)
+after which the authentication cookie will expire.
+
+```shell
+$ elapi patch config -d '{"cookie_validity_time": 43200}'
+```
+
+We can publish an announcement to all the members.
+
+```shell
+$ elapi patch config -d '{"announcement": "Notice: Server will be down tomorrow at midnight due to scheduled maintenance."}'
 ```
 
 ### Bill teams

{elapi-1.0.5 → elapi-1.0.7.dev1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "elapi"
-version = "1.0.5"
+version = "1.0.7-dev1"
 description = """elAPI is a powerful, extensible API interface to eLabFTW built for \
 the University Computing Centre (URZ, FIRE division) at Universität Heidelberg."""
 authors = [
@@ -40,6 +40,7 @@ typer = { extras = ["all"], version = "^0.9.0" }
 pyyaml = "^6.0.1"
 python-dateutil = "^2.8.2"
 tenacity = "^8.2.3"
+mistune = "^3.0.2"
 
 [tool.poetry.group.dev.dependencies]
 ptpython = "^3.0.23"

elapi-1.0.7.dev1/src/elapi/VERSION

@@ -0,0 +1 @@
+1.0.7-dev1

{elapi-1.0.5 → elapi-1.0.7.dev1}/src/elapi/_names.py

@@ -1,8 +1,5 @@
 import os
 from pathlib import Path
-from typing import Union
-
-from .path import ProperPath
 
 # variables with leading underscores here indicate that they are to be overwritten by config.py
 # In which case, import their counterparts from src/config.py
@@ -10,6 +7,7 @@ from .path import ProperPath
 APP_NAME: str = "elapi"
 LOG_FILE_NAME: str = f"{APP_NAME}.log"
 CONFIG_FILE_NAME: str = f"{APP_NAME}.yml"
+DEFAULT_EXPORT_DATA_FORMAT: str = "json"
 user_home: Path = Path.home()
 cur_dir: Path = Path.cwd()
 
@@ -17,9 +15,9 @@ cur_dir: Path = Path.cwd()
 # https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html
 
 # XDG and other convention variable definitions
-ENV_XDG_DATA_HOME: Union[ProperPath, Path, str] = "XDG_DATA_HOME"
-ENV_XDG_DOWNLOAD_DIR: Union[ProperPath, Path, str] = "XDG_DOWNLOAD_DIR"
-ENV_XDG_CONFIG_HOME: Union[ProperPath, Path, str] = "XDG_CONFIG_HOME"
+ENV_XDG_DATA_HOME: str = "XDG_DATA_HOME"
+ENV_XDG_DOWNLOAD_DIR: str = "XDG_DOWNLOAD_DIR"
+ENV_XDG_CONFIG_HOME: str = "XDG_CONFIG_HOME"
 TMP_DIR: Path = Path(f"/var/tmp/{APP_NAME}")
 
 # Fallback definitions
@@ -30,8 +28,8 @@ FALLBACK_CONFIG_DIR: Path = user_home / ".config"
 # Configuration path definitions
 SYSTEM_CONFIG_LOC: Path = Path("/etc") / CONFIG_FILE_NAME
 LOCAL_CONFIG_LOC: Path = (
-    os.getenv(ENV_XDG_CONFIG_HOME) or FALLBACK_CONFIG_DIR
-) / CONFIG_FILE_NAME
+    Path(os.getenv(ENV_XDG_CONFIG_HOME, FALLBACK_CONFIG_DIR)) / CONFIG_FILE_NAME
+)
 # In case, $XDG_CONFIG_HOME isn't defined in the machine, it falls back to $HOME/.config/elapi.yml
 PROJECT_CONFIG_LOC: Path = cur_dir / CONFIG_FILE_NAME