ITQC/pydase_service_base
24
0
Fork 0
mirror of https://github.com/tiqi-group/pydase_service_base.git synced 2025-06-07 21:10:42 +02:00
Code Issues Packages Projects Releases Wiki Activity

updates Readme (moving from gitlab.phys.ethz.ch to github.com)

Browse Source
This commit is contained in:
Mose Mueller 2024-10-31 07:47:13 +01:00
parent 174dea0b33
commit f9a3ec8ba6
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -7,28 +7,28 @@
Ensure you have Python 3.10 or later installed on your system. Dependencies of this package are managed with [`poetry`](https://python-poetry.org/docs/#installation). Install the `pydase_service_base` as follows:
```bash
poetry add git+ssh://git@gitlab.phys.ethz.ch:tiqi-projects/qchub/icon-services/pydase_service_base.git
poetry add git+ssh://git@github.com:tiqi-group/pydase_service_base.git
```
To utilize specific functionalities such as `IonizerServer`, `InfluxDBSession`, or `PostgresDatabaseSession`, you need to install the relevant optional dependencies:
- For `IonizerServer`, include the `ionizer` extra:
```bash
poetry add "git+ssh://git@gitlab.phys.ethz.ch:tiqi-projects/qchub/icon-services/pydase_service_base.git#main[ionizer]"
poetry add "git+ssh://git@github.com:tiqi-group/pydase_service_base.git#main[ionizer]"
```
- For `InfluxDBSession`, include the `influxdbv2` extra:
```bash
poetry add "git+ssh://git@gitlab.phys.ethz.ch:tiqi-projects/qchub/icon-services/pydase_service_base.git#main[influxdbv2]"
poetry add "git+ssh://git@github.com:tiqi-group/pydase_service_base.git#main[influxdbv2]"
```
- For `PostgresDatabaseSession`, include the `postgresql` extra:
```bash
poetry add "git+ssh://git@gitlab.phys.ethz.ch:tiqi-projects/qchub/icon-services/pydase_service_base.git#main[postgresql]"
poetry add "git+ssh://git@github.com:tiqi-group/pydase_service_base.git#main[postgresql]"
```
or directly add the following line to the `pyproject.toml` file:
```toml
pydase-service-base = {git = "git@gitlab.phys.ethz.ch:tiqi-projects/qchub/icon-services/pydase_service_base.git", rev = "main", extras = ["ionizer", "postgresql", "ionizer"]}
pydase-service-base = {git = "git@github.com:tiqi-group/pydase_service_base.git", rev = "main", extras = ["ionizer", "postgresql", "ionizer"]}
```
## Configuration