diff --git a/CHANGELOG.md b/CHANGELOG.md
index 7a97a2b7bd39d78f7176607dc59f59c6824a35cf..1592ac685731f0e132a2317559335f3fed924fa2 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -9,6 +9,25 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Added ###
+### Changed ###
+
+### Deprecated ###
+- `connection.get_username`. Use `la.Info().user_info.name` instead.
+
+### Removed ###
+
+### Fixed ###
+
+### Security ###
+
+### Documentation ###
+
+* Added docstrings for `linkahead.models.Info` and `linkahead.models.UserInfo`.
+
+## [0.15.0] - 2024-07-09 ##
+
+### Added ###
+
* Support for Python 3.12
* The `linkahead` module now opts into type checking and supports mypy.
* [#112](https://gitlab.com/linkahead/linkahead-pylib/-/issues/112)
@@ -21,8 +40,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
* Using environment variable PYLINKAHEADINI instead of PYCAOSDBINI.
-### Deprecated ###
-
### Removed ###
* Support for Python 3.7
@@ -37,8 +54,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
* [#120](https://gitlab.com/linkahead/linkahead-pylib/-/issues/120) Unwanted
subproperties in reference properties.
-### Security ###
-
### Documentation ###
* Added documentation and a tutorial example for the usage of the `page_length`
diff --git a/CITATION.cff b/CITATION.cff
index cbcb570b27b7cd71f50645614222302bccc34805..148cccb1804f7ae254224074dfef408e014f5438 100644
--- a/CITATION.cff
+++ b/CITATION.cff
@@ -20,6 +20,6 @@ authors:
given-names: Stefan
orcid: https://orcid.org/0000-0001-7214-8125
title: CaosDB - Pylib
-version: 0.14.0
+version: 0.15.0
doi: 10.3390/data4020083
-date-released: 2024-02-20
+date-released: 2024-07-09
diff --git a/setup.py b/setup.py
index ee2a5fb6fd7212acfc9ce9bc732fc9f2d4f345b4..7b499d91cdd6e52856320a9e573f0742e1d54e81 100755
--- a/setup.py
+++ b/setup.py
@@ -48,7 +48,7 @@ from setuptools import find_packages, setup
ISRELEASED = False
MAJOR = 0
-MINOR = 14
+MINOR = 15
MICRO = 1
# Do not tag as pre-release until this commit
# https://github.com/pypa/packaging/pull/515
diff --git a/src/doc/conf.py b/src/doc/conf.py
index 61a60d7c9e8d5c6b0959f4bba230cd483c06bc79..98e5b6c66e336c595c0feb6c1c47d5ac1db88a79 100644
--- a/src/doc/conf.py
+++ b/src/doc/conf.py
@@ -29,10 +29,10 @@ copyright = '2023, IndiScale GmbH'
author = 'Daniel Hornung'
# The short X.Y version
-version = '0.14.1'
+version = '0.15.1'
# The full version, including alpha/beta/rc tags
# release = '0.5.2-rc2'
-release = '0.14.1-dev'
+release = '0.15.1-dev'
# -- General configuration ---------------------------------------------------
diff --git a/src/linkahead/common/models.py b/src/linkahead/common/models.py
index 98fc28a47a3c7b034b4b6f1dc12481f62fc69fd4..96851f34bd7558e03fb60d92ca001d8cd7c43171 100644
--- a/src/linkahead/common/models.py
+++ b/src/linkahead/common/models.py
@@ -1998,8 +1998,6 @@ class Property(Entity):
Parameters
----------
- Parameters
- ----------
parent : Entity or int or str or None
The parent entity, either specified by the Entity object
itself, or its id or its name. Default is None.
@@ -3192,9 +3190,15 @@ class Container(list):
"""Get an xml tree representing this Container or append all entities
to the given xml element.
- @param add_to_element=None: optional element to which all entities of this container is to
- be appended.
- @return xml element
+ Parameters
+ ----------
+ add_to_element : etree._Element, optional
+ optional element to which all entities of this container is to
+ be appended. Default is None
+
+ Returns
+ -------
+ xml_element : etree._Element
"""
tmpid = 0
@@ -4072,13 +4076,21 @@ class Container(list):
warnings as errors. This prevents the server from inserting this entity if any warning
occurs.
- @param strict=False: Flag for strict mode.
- @param sync=True: synchronize this container with the response from the server. Otherwise,
- this method returns a new container with the inserted entities and leaves
- this container untouched.
- @param unique=True: Flag for unique mode. If set to True, the server will check if the name
- of the entity is unique. If not, the server will return an error.
- @param flags=None: Additional flags for the server.
+ Parameters
+ ----------
+ strict : bool, optional
+ Flag for strict mode. Default is False.
+ sync : bool, optional
+ synchronize this container with the response from the
+ server. Otherwise, this method returns a new container with the
+ inserted entities and leaves this container untouched. Default is
+ True.
+ unique : bool, optional
+ Flag for unique mode. If set to True, the server will check if the
+ name of the entity is unique. If not, the server will return an
+ error. Default is True.
+ flags : dict, optional
+ Additional flags for the server. Default is None.
"""
@@ -5019,6 +5031,17 @@ class DropOffBox(list):
class UserInfo():
+ """User information from a server response.
+
+ Attributes
+ ----------
+ name : str
+ Username
+ realm : str
+ Realm in which this user lives, e.g., CaosDB or LDAP.
+ roles : list[str]
+ List of roles assigned to this user.
+ """
def __init__(self, xml: etree._Element):
self.roles = [role.text for role in xml.findall("Roles/Role")]
@@ -5027,6 +5050,21 @@ class UserInfo():
class Info():
+ """Info about the LinkAhead instance that you are connected to. It has a
+ simple string representation in the form of "Connected to a LinkAhead with N
+ Records".
+
+ Attributes
+ ----------
+ messages : Messages
+ Collection of messages that the server's ``Info`` response contained.
+ user_info : UserInfo
+ Information about the user that is connected to the server, such as
+ name, realm or roles.
+ time_zone : TimeZone
+ The timezone information returned by the server.
+
+ """
def __init__(self):
self.messages = Messages()
@@ -5035,6 +5073,7 @@ class Info():
self.sync()
def sync(self):
+ """Retrieve server information from the server's ``Info`` response."""
c = get_connection()
try:
http_response = c.retrieve(["Info"])
diff --git a/src/linkahead/connection/connection.py b/src/linkahead/connection/connection.py
index 294d9457d064f03bbe06a3347b2d2064dcf12b8c..c95134fed3fd6b031b01b518c6362bf3b371c960 100644
--- a/src/linkahead/connection/connection.py
+++ b/src/linkahead/connection/connection.py
@@ -757,6 +757,8 @@ class _Connection(object): # pylint: disable=useless-object-inheritance
Shortcut for: get_connection()._authenticator._credentials_provider.username
"""
+ warnings.warn("Deprecated. Please use ``la.Info().user_info.name`` instead.",
+ DeprecationWarning)
if self._authenticator is None:
raise ValueError(
"No authenticator set. Please call configure_connection() first.")