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 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.
Metadata
Release files for daq-config-server 1.6.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| daq_config_server-1.6.2.tar.gz | 216.6 kB | Without provenance | Details for daq_config_server-1.6.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| daq_config_server-1.6.2-py3-none-any.whl | Python 3 | none | any | Details for daq_config_server-1.6.2-py3-none-any.whl |
Total release size: 255.2 kB
Release files / daq_config_server-1.6.2.tar.gz
| Download URL | daq_config_server-1.6.2.tar.gz |
|---|---|
| Size | 216.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7a97064e3f9f848c08f40a6daf6ce3b73974450d194b8c6b8fd8abeb4e3c95a6
|
|
BLAKE2b-256 checksum How to use checksums |
d743a3503df23f40c7e2c53ffd5c9797fa244df4d034b98f7b8573cbe7a58839
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Release files / daq_config_server-1.6.2-py3-none-any.whl
| Download URL | daq_config_server-1.6.2-py3-none-any.whl |
|---|---|
| Size | 38.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9255512ac61a4844af51d92ba2a5f7b3864a21c516649955a4ea412f1ce311ef
|
|
BLAKE2b-256 checksum How to use checksums |
711c0b104e3fb9cacb248d19ce8e892d9d6de857c49a8410f4c17939fe8b6808
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Security for daq-config-server 1.6.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.