No SQL in-memory Tango database for testing.

It provides

• An human readable data structure based on Yaml to describe the content of a tango database;
• Helpers to launch such database in python for testing.

The code was previously at:

• https://github.com/tango-controls/pytango/blob/a8f6a3bfbf547f5b1bb22772280f0eb6e655486f/tango/databaseds/db_access/beacon.py
• https://gitlab.esrf.fr/bliss/bliss/-/commit/c17bcc328d337de856449e3826023dc9f7dac858

Connectors

Two connectors are provided using the same data structure:

• beacon using a Redis/Beacon infrastructure to store the database;
• yaml using direct yaml files with in-memory only storage.

Command line

The database can be launched the following ways.

Using the actual Redis database:

NosqlTangoDB --port 10000 --db_access=beacon 2

Using a specific directory containing Yaml files:

NosqlTangoDB --port 10000 --db_access=yaml:tests/data/test1/ 2

Using a specific hostname

NosqlTangoDB --port 10000 --host localhost --db_access=yaml:tests/data/test1/ 2

Python

The following code can be used in Python projects.

It spawns the database process with a context manager.

The port is yield when the database is ready to be used.

It finally terminates the database process.

from nosqltangodb import helper

with helper.running_db(
    name="2",
    db_access="yaml",
    yaml_root=yaml_root,
    port="auto",
    debug_protocol=True,
    update_tango_host=True,
    timeout=10,
) as db:
    print("Tango DB port:", db.port)

Project release

Here is the template for pypi credencial.

# ~/.pypirc
[nosql-tango-db]
repository = https://upload.pypi.org/legacy/
username = __token__
password = pypi-...

The project uses setuptools-scm configured such way the distribution is tagged according to the actual commit tag.

Tag your release:

git tag x.y.z

Build the package:

pixi run dist

# The wheel is created inside ./dist
ls ./dist

Upload the result to pypi:

pixi run upload
# Same as: twine upload dist/nosqltangodb-*.whl -r nosqltangodb

Finally:

git push --tag