Compare commits

...

3 Commits
v0.3.1 ... main

Author SHA1 Message Date
Mose Mueller
854fc49c75 updates version to v0.3.2 2025-04-04 10:58:20 +02:00
Mose Mueller
a3b9fc1fb5 fixes types for python 3.10 2025-04-04 10:57:46 +02:00
Mose Müller
8af6513aaf
Update README.md 2024-12-19 11:52:50 +01:00
3 changed files with 13 additions and 12 deletions

View File

@ -32,12 +32,12 @@ To utilize specific functionalities such as `IonizerServer`, `InfluxDBv1Session`
or directly add the following line to the `pyproject.toml` file: or directly add the following line to the `pyproject.toml` file:
```toml ```toml
pydase-service-base = {git = "https://github.com/tiqi-group/pydase_service_base.git", rev = "main", extras = ["ionizer", "postgresql", "ionizer"]} pydase_service_base = {git = "https://github.com/tiqi-group/pydase_service_base.git", rev = "main", extras = ["ionizer", "postgresql", "influxdbv1", "influxdbv2"]}
``` ```
## Configuration ## Configuration
Database connections rely on configurations provided either through 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 configuration files for the databases. Override the `database_config` folder's location by passing a different path to the database classes' constructor. 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: Structure of the `database_config` folder:
@ -160,7 +160,7 @@ with PostgresDatabaseSession() as session:
### Ionizer Interface ### Ionizer Interface
The `IonizerServer` provides an interface to seamlessly integrate `pydase` applications with Ionizer. **This requires the `ionizer` optional dependency**. The `IonizerServer` provides an interface to integrate `pydase` applications with Ionizer seamlessly. **This requires the `ionizer` optional dependency**.
To deploy `IonizerServer` with your service: To deploy `IonizerServer` with your service:
@ -190,7 +190,7 @@ if __name__ == "__main__":
This integration ensures that your primary `pydase` server and `YourServiceClass` service are set up. It also incorporates the `IonizerServer` on port `8002`. 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`, refer to the [official documentation](https://pydase.readthedocs.io/en/latest/) or get in touch with the maintainers. For more details on the `IonizerServer`, get in touch with the maintainers.
## License ## License

View File

@ -1,16 +1,17 @@
from __future__ import annotations from __future__ import annotations
import logging import logging
import sys
from typing import TYPE_CHECKING, Any, NamedTuple from typing import TYPE_CHECKING, Any, NamedTuple
try: if sys.version_info < (3, 11):
from typing import Self # type: ignore
except ImportError:
from typing_extensions import Self from typing_extensions import Self
else:
from typing import Self
from confz import FileSource from confz import FileSource
from influxdb_client import ( from influxdb_client import ( # type: ignore
Bucket, Bucket,
BucketRetentionRules, BucketRetentionRules,
BucketsApi, BucketsApi,
@ -19,9 +20,9 @@ from influxdb_client import (
WriteApi, WriteApi,
WritePrecision, WritePrecision,
) )
from influxdb_client.client.write.point import DEFAULT_WRITE_PRECISION from influxdb_client.client.write.point import DEFAULT_WRITE_PRECISION # type: ignore
from influxdb_client.client.write_api import SYNCHRONOUS from influxdb_client.client.write_api import SYNCHRONOUS # type: ignore
from influxdb_client.rest import ApiException from influxdb_client.rest import ApiException # type: ignore
from pydase_service_base.database.config import InfluxDBConfig, ServiceConfig from pydase_service_base.database.config import InfluxDBConfig, ServiceConfig

View File

@ -1,6 +1,6 @@
[tool.poetry] [tool.poetry]
name = "pydase-service-base" name = "pydase-service-base"
version = "0.3.1" version = "0.3.2"
description = "Repository storing the code that is common to all pydase services." description = "Repository storing the code that is common to all pydase services."
authors = ["Mose Mueller <mosmuell@ethz.ch>"] authors = ["Mose Mueller <mosmuell@ethz.ch>"]
license = "MIT" license = "MIT"