OMERO user token

Python package that creates long running user tokens for use with the OMERO API under non-interactive, headless conditions.

Requirements

• Python 3.9+
• OMERO.server 5.6

Usage

Creating a user token and making it active:

omero-user-token set

Please see omero-user-token set --help for detailed information. The default server hostname and port can be set in ${HOME}/.omero_user_token/config using an INI file compatible style:

[server]
host = omero.example.com
port = 4064

Retrieving the current active token (validation will be performed):

omero-user-token get

Token format

The token format is as follows:

<omero_session_key>@<host>:<port>

Example usage

Bash:

token=$(omero-user-token get)
if [ $? -ne 0]; then
    echo "No valid token found"
    exit 1
fi
key=$(echo "${token}" | sed -e 's/^\(.*\)@.*:.*$/\1/')
host=$(echo "${token}" | sed -e 's/^.*@\(.*\):.*$/\1/')
port=$(echo "${token}" | sed -e 's/^.*@.*:\(.*\)$/\1/')
echo "Connecting to ${host}:${port} with key ${key}"

Python:

from omero_user_token import getter
token = getter()
if token is not None:
    omero_session_key = token[:token.find('@')]
    host, port = token[token.find('@') + 1:].split(':')
    port = int(port)
    key = token[:token.find('@')]
    print(f"Connecting to {host}:{port} with key {key}")

License

OMERO user token is distributed under the terms of the GPL v2 license. Please see LICENSE.txt for further details.