DAQ Config Server
A service to read files on Diamond's filesystem from a BlueAPI container. Currently this service is only able to read files on /dls_sw/. Writing to configuration files will come in a future release.
| Source | https://github.com/DiamondLightSource/daq-config-server |
|---|---|
| Docker | docker run ghcr.io/DiamondLightSource/daq-config-server:latest |
| Releases | https://github.com/DiamondLightSource/daq-config-server/releases |
| Documentation | https://DiamondLightSource.github.io/daq-config-server |
Here is a minimal example to read a file from the centrally hosted service after installing this package
from daq_config_server.client import ConfigClient
config_client = ConfigClient("https://daq-config.diamond.ac.uk")
file_contents = config_client.get_file_contents({ABSOLUTE_PATH_TO_CONFIG_FILE}, desired_return_type=str)
The output will come out as a raw string - you should format it as required in your own code. You may also request that the file contents is returned as a dict or in bytes - this will raise an http exception if the file cannot be converted to that type. To be able to read a file, you must first add it to the whitelist.
Testing
To run unit tests, type tox -e unit_tests from within the dev container
There is a convenient script in ./deployment/build_and_push.sh which can be used to easily build and run the container locally for testing, and optionally push the container to a repository. In general we should rely on the CI to be pushing new containers - however it is sometimes useful to push a development image to a private repo for development or debugging.
To run local system tests, start a local container by running ./deployment/build_and_push.sh -r -b. Then, in the dev container, forward port 8555. There are instructions on port forwarding within vscode here. Next, in a terminal in the devcontainer, run tox -e system_tests_local from the daq-config-server directory.
To run a test deployment on argus, log in to argus in your namespace and run:
helm install daq-config ./helmchart/ --values dev-values.yaml
followed by:
kubectl port-forward service/daq-config-server-svc 8555
after which you should be able to access the API on http://localhost:8555/docs
See https://DiamondLightSource.github.io/daq-config-server for more detailed documentation.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file daq_config_server-1.5.0.tar.gz.
File metadata
- Download URL: daq_config_server-1.5.0.tar.gz
- Upload date:
- Size: 236.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
79710aaf04531e6c11f18b31b5e92945bf21b7e72a86786912715ec3120098be
|
|
| MD5 |
6799be6f54d02ddb64a41c451b6b7921
|
|
| BLAKE2b-256 |
d70f1d53b7ad3d6450f78a7def96b0a9dabf19727ad0805f1d0cb4c85d1cabbf
|
File details
Details for the file daq_config_server-1.5.0-py3-none-any.whl.
File metadata
- Download URL: daq_config_server-1.5.0-py3-none-any.whl
- Upload date:
- Size: 36.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9a5b2a1527ad19fa4bcbe5139b5d89a9ad83192ce7dc533fa54dbae183abc0d3
|
|
| MD5 |
e72fe7cb3eb18354852e56a421be7afd
|
|
| BLAKE2b-256 |
4a8945470075c1825d888c16a908cbb258b848a4c6eaf33a9cd11dd3df5fbd66
|
