pydase Service Base

pydase Service Base is a shared code repository for pydase services in a service-based architecture. Written in Python, it provides the essential functionality for interacting with PostgreSQL and InfluxDB v2 databases. In addition, it offers the Ionizer Interface, enabling seamless integration between pydase applications and the Ionizer system.

Installation

Ensure you have Python 3.10 or later installed on your system. Dependencies of this package are managed with poetry. Install the pydase_service_base as follows:

poetry add git+https://github.com/tiqi-group/pydase_service_base.git

To utilize specific functionalities such as IonizerServer, InfluxDBv1Session,InfluxDBSession, or PostgresDatabaseSession, you need to install the relevant optional dependencies:

• For IonizerServer, include the ionizer extra:

  poetry add "git+https://github.com/tiqi-group/pydase_service_base.git#main[ionizer]"

• For InfluxDBv1Session, include the influxdbv1 extra:

  poetry add "git+https://github.com/tiqi-group/pydase_service_base.git#main[influxdbv1]"

• For InfluxDBSession, include the influxdbv2 extra:

  poetry add "git+https://github.com/tiqi-group/pydase_service_base.git#main[influxdbv2]"

• For PostgresDatabaseSession, include the postgresql extra:

  poetry add "git+https://github.com/tiqi-group/pydase_service_base.git#main[postgresql]"

or directly add the following line to the pyproject.toml file:

pydase_service_base = {git = "https://github.com/tiqi-group/pydase_service_base.git", rev = "main", extras = ["ionizer", "postgresql", "influxdbv1", "influxdbv2"]}

Configuration

Database connections rely on configurations provided by environment variables or a specific configuration file. The package anticipates a database_config folder in the root directory of any module using this package. This folder should house the database configuration files. You can override the database_config folder's location by passing a different path to the database classes' constructor.

Structure of the database_config folder:

database_config
├── influxdbv1_config.yaml
├── influxdb_config.yaml
├── postgres_development.yaml
└── postgres_production.yaml

Example content for the configuration files:

influxdbv1_config.yaml:

host: https://influxdb.phys.ethz.ch
port: 443  # defaults to 8086 (default port of influxdb)
username: root
password: root
database: my_database
ssl: True  # defaults to True
verify_ssl: True  # defaults to True

influxdb_config.yaml:

url: https://database-url.ch
org: your-org
token: <influxdb-token>

postgres_development.yaml / postgres_production.yaml:

database: ...
host: https://database-url.ch
port: 5432
password: ...
user: ...

Usage

InfluxDBv1Session

Interact with an InfluxDBv1 server using the InfluxDBv1Session class. Note that this class only supports InfluxDB v1 and requires the influxdbv1 optional dependency.

from pydase_service_base.database import InfluxDBv1Session

with InfluxDBv1Session() as influx_client:
    # Writing points to a database
    points = [
        {
            "measurement": "your_measurement",  # Replace with your measurement
            "tags": {
                "example_tag": "tag_value",  # Replace with your tag and value
            },
            "fields": {
                "example_field": 123,  # Replace with your field and its value
            },
            "time": "2023-06-05T00:00:00Z",  # Replace with your timestamp
        }
    ]
    influx_client.write_points(points=points, database="other_database")

Note that you have to set ssl and verify_ssl to False when you are using a local influxdb instance.

InfluxDBSession

Interact with an InfluxDB server using the InfluxDBSession class. Note that this class only supports InfluxDB v2 and requires the influxdbv2 optional dependency.

from pydase_service_base.database import InfluxDBSession

with InfluxDBSession() as influx_client:
    # Creating a bucket
    influx_client.create_bucket(
        bucket_name='my_new_bucket', description='This is a new bucket'
    )

    # Writing data to a bucket
    record = {
        "measurement": "your_measurement",  # Replace with your measurement
        "tags": {
            "example_tag": "tag_value",  # Replace with your tag and its value
        },
        "fields": {
            "example_field": 123,  # Replace with your field and its value
        },
        "time": "2023-06-05T00:00:00Z",  # Replace with your timestamp
    }
    influx_client.write(
        bucket='my_new_bucket', record=record
    )

PostgresDatabaseSession

The PostgresDatabaseSession class allows interactions with a PostgreSQL database. This class requires the postgresql optional dependency.

from pydase_service_base.database import PostgresDatabaseSession
from your_module.models import YourModel  # replace with your model
from sqlmodel import select

with PostgresDatabaseSession() as session:
    row = session.exec(select(YourModel).limit(1)).all()

You can also use it to add new data to the table:

with PostgresDatabaseSession() as session:
    new_row = YourModel(...)  # replace ... with your data
    session.add(new_row)
    session.commit()

Ionizer Interface

The IonizerServer provides an interface to integrate pydase applications with Ionizer seamlessly. This requires the ionizer optional dependency.

To deploy IonizerServer with your service:

from pydase_service_base.ionizer_interface import IonizerServer

class YourServiceClass:
    # your implementation...


if __name__ == "__main__":
    # Instantiate your service
    service = YourServiceClass()

    # Start the main pydase server with IonizerServer as an additional server
    Server(
        service,
        additional_servers=[
            {
                "server": IonizerServer,
                "port": 8002,
                "kwargs": {},
            }
        ],
    ).run()

This integration ensures that your primary pydase server and YourServiceClass service are set up. It also incorporates the IonizerServer on port 8002.

For more details on the IonizerServer, get in touch with the maintainers.

License

This project uses the MIT License. Consult the LICENSE file for more information.