daq-config-server 0.1.0__py3-none-any.whl

daq_config_server/__init__.py

@@ -0,0 +1,3 @@
+from ._version import __version__
+
+__all__ = ["__version__"]

daq_config_server/__main__.py

@@ -0,0 +1,37 @@
+from argparse import ArgumentParser
+
+from . import __version__
+
+try:
+    import redis  # noqa
+    import uvicorn  # noqa
+    from fastapi import FastAPI  # noqa
+
+    server_dependencies_exist = True
+except ImportError:
+    server_dependencies_exist = False
+
+
+__all__ = ["main"]
+
+
+def main():
+    parser = ArgumentParser()
+    parser.add_argument("-v", "--version", action="version", version=__version__)
+    parser.add_argument("-d", "--dev", action="store_true")
+    args = parser.parse_args()
+    if not server_dependencies_exist:
+        print(
+            "To do anything other than print the version and be available for "
+            "importing the client, you must install this package with [server] "
+            "optional dependencies"
+        )
+    else:
+        from .app import main
+
+        main(args)
+
+
+# test with: python -m daq_config_server
+if __name__ == "__main__":
+    main()

daq_config_server/_version.py

@@ -0,0 +1,16 @@
+# file generated by setuptools_scm
+# don't change, don't track in version control
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple, Union
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+else:
+    VERSION_TUPLE = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+
+__version__ = version = '0.1.0'
+__version_tuple__ = version_tuple = (0, 1, 0)

daq_config_server/app.py

@@ -0,0 +1,144 @@
+from os import environ
+
+import uvicorn
+from fastapi import FastAPI, Request, Response, status
+from fastapi.middleware.cors import CORSMiddleware
+from redis import Redis
+
+from .beamline_parameters import (
+    BEAMLINE_PARAMETER_PATHS,
+    GDABeamlineParameters,
+)
+from .constants import DATABASE_KEYS, ENDPOINTS
+
+DEV_MODE = bool(int(environ.get("DEV_MODE") or 0))
+
+ROOT_PATH = "/api"
+print(f"{DEV_MODE=}")
+print(f"{ROOT_PATH=}")
+if DEV_MODE:
+    print("Running in dev mode! not setting root path!")
+    ROOT_PATH = ""
+
+app = FastAPI(
+    title="DAQ config server",
+    description="""For storing and fetching beamline parameters, etc. which are needed
+    by more than one applicatioon or service""",
+    root_path=ROOT_PATH,
+)
+origins = ["*"]
+app.add_middleware(
+    CORSMiddleware,
+    allow_origins=origins,
+    allow_credentials=True,
+    allow_methods=["*"],
+    allow_headers=["*"],
+)
+
+valkey = Redis(host="localhost", port=6379, decode_responses=True)
+
+__all__ = ["main"]
+
+BEAMLINE_PARAM_PATH = ""
+BEAMLINE_PARAMS: GDABeamlineParameters | None = None
+
+
+@app.get(ENDPOINTS.BL_PARAM + "/{param}")
+def get_beamline_parameter(param: str):
+    """Get a single beamline parameter"""
+    assert BEAMLINE_PARAMS is not None
+    return {param: BEAMLINE_PARAMS.params.get(param)}
+
+
+@app.get(ENDPOINTS.BL_PARAM)
+def get_all_beamline_parameters():
+    """Get a dict of all the current beamline parameters."""
+    assert BEAMLINE_PARAMS is not None
+    return BEAMLINE_PARAMS.params
+
+
+@app.get(ENDPOINTS.FEATURE)
+def get_feature_flag_list(get_values: bool = False):
+    """Get a list of all the current feature flags, or a dict of all the current values
+    if get_values=true is passed"""
+    flags = valkey.smembers(DATABASE_KEYS.FEATURE_SET)
+    if not get_values:
+        return flags
+    else:
+        return {flag: bool(int(valkey.get(flag))) for flag in flags}  # type: ignore
+
+
+@app.get(ENDPOINTS.FEATURE + "/{flag_name}")
+def get_feature_flag(flag_name: str, response: Response):
+    """Get the value of a feature flag"""
+    if not valkey.sismember(DATABASE_KEYS.FEATURE_SET, flag_name):
+        response.status_code = status.HTTP_404_NOT_FOUND
+        return {"message": f"Feature flag {flag_name} does not exist!"}
+    else:
+        ret = int(valkey.get(flag_name))  # type: ignore # We checked if it exists above
+        return {flag_name: bool(ret)}
+
+
+@app.post(ENDPOINTS.FEATURE + "/{flag_name}", status_code=status.HTTP_201_CREATED)
+def create_feature_flag(flag_name: str, response: Response, value: bool = False):
+    """Sets a feature flag, creating it if it doesn't exist. Default to False."""
+    if valkey.sismember(DATABASE_KEYS.FEATURE_SET, flag_name):
+        response.status_code = status.HTTP_409_CONFLICT
+        return {"message": f"Feature flag {flag_name} already exists!"}
+    else:
+        valkey.sadd(DATABASE_KEYS.FEATURE_SET, flag_name)
+        return {"success": valkey.set(flag_name, int(value))}
+
+
+@app.put(ENDPOINTS.FEATURE + "/{flag_name}")
+def set_feature_flag(flag_name: str, value: bool, response: Response):
+    """Sets a feature flag, return an error if it doesn't exist."""
+    if not valkey.sismember(DATABASE_KEYS.FEATURE_SET, flag_name):
+        response.status_code = status.HTTP_404_NOT_FOUND
+        return {"message": f"Feature flag {flag_name} does not exist!"}
+    else:
+        return {"success": valkey.set(flag_name, int(value))}
+
+
+@app.delete(ENDPOINTS.FEATURE + "/{flag_name}")
+def delete_feature_flag(flag_name: str, response: Response):
+    """Delete a feature flag."""
+    if not valkey.sismember(DATABASE_KEYS.FEATURE_SET, flag_name):
+        response.status_code = status.HTTP_404_NOT_FOUND
+        return {"message": f"Feature flag {flag_name} does not exist!"}
+    else:
+        valkey.srem(DATABASE_KEYS.FEATURE_SET, flag_name)
+        return {"success": not valkey.sismember(DATABASE_KEYS.FEATURE_SET, flag_name)}
+
+
+@app.get(ENDPOINTS.INFO)
+def get_info(request: Request):
+    """Get some generic information about the request, mostly for debugging"""
+    return {
+        "message": "Welcome to daq-config API.",
+        "root_path": request.scope.get("root_path"),
+        "request_headers": request.headers,
+    }
+
+
+if DEV_MODE:
+
+    @app.api_route("/{full_path:path}")
+    async def catch_all(request: Request, full_path: str):
+        return {
+            "message": "resource not found, supplying info for debug",
+            "root_path": request.scope.get("root_path"),
+            "path": full_path,
+            "request_headers": repr(request.headers),
+        }
+
+
+def main(args):
+    global BEAMLINE_PARAM_PATH
+    global BEAMLINE_PARAMS
+    if args.dev:
+        BEAMLINE_PARAM_PATH = "tests/test_data/beamline_parameters.txt"
+    else:
+        BEAMLINE_PARAM_PATH = BEAMLINE_PARAMETER_PATHS["i03"]
+    BEAMLINE_PARAMS = GDABeamlineParameters.from_file(BEAMLINE_PARAM_PATH)
+    uvicorn.run(app="daq_config_server.app:app", host="0.0.0.0", port=8555)

daq_config_server/beamline_parameters.py

@@ -0,0 +1,86 @@
+from logging import Logger
+from typing import Any, cast
+
+LOGGER = Logger(__name__)
+BEAMLINE_PARAMETER_KEYWORDS = ["FB", "FULL", "deadtime"]
+
+BEAMLINE_PARAMETER_PATHS = {
+    "i03": "/dls_sw/i03/software/daq_configuration/domain/beamlineParameters",
+    "i04": "/dls_sw/i04/software/gda_versions/gda_9_29/workspace_git/gda-mx.git/configurations/i04-config/scripts/beamlineParameters",  # noqa
+    "s03": "tests/test_data/test_beamline_parameters.txt",
+}
+
+
+class GDABeamlineParameters:
+    params: dict[str, Any]
+
+    def __repr__(self) -> str:
+        return repr(self.params)
+
+    def __getitem__(self, item: str):
+        return self.params[item]
+
+    @classmethod
+    def from_lines(cls, file_name: str, config_lines: list[str]):
+        ob = cls()
+        config_lines_nocomments = [line.split("#", 1)[0] for line in config_lines]
+        config_lines_sep_key_and_value = [
+            # XXX removes all whitespace instead of just trim
+            line.translate(str.maketrans("", "", " \n\t\r")).split("=")
+            for line in config_lines_nocomments
+        ]
+        config_pairs: list[tuple[str, Any]] = [
+            cast(tuple[str, Any], param)
+            for param in config_lines_sep_key_and_value
+            if len(param) == 2
+        ]
+        for i, (param, value) in enumerate(config_pairs):
+            try:
+                # BEAMLINE_PARAMETER_KEYWORDS effectively raw string, whitespace removed
+                if value not in BEAMLINE_PARAMETER_KEYWORDS:
+                    config_pairs[i] = (
+                        param,
+                        cls.parse_value(value),
+                    )
+            except Exception as e:
+                LOGGER.warning(f"Unable to parse {file_name} line {i}: {e}")
+
+        ob.params = dict(config_pairs)
+        return ob
+
+    @classmethod
+    def from_file(cls, path: str):
+        with open(path) as f:
+            config_lines = f.readlines()
+        return cls.from_lines(path, config_lines)
+
+    @classmethod
+    def parse_value(cls, value: str):
+        if value[0] == "[":
+            return cls.parse_list(value[1:].strip())
+        else:
+            return cls.parse_list_element(value)
+
+    @classmethod
+    def parse_list_element(cls, value: str):
+        if value == "Yes":
+            return True
+        elif value == "No":
+            return False
+        else:
+            return float(value)
+
+    @classmethod
+    def parse_list(cls, value: str):
+        list_output = []
+        remaining = value.strip()
+        i = 0
+        while (i := remaining.find(",")) != -1:
+            list_output.append(cls.parse_list_element(remaining[:i]))
+            remaining = remaining[i + 1 :].lstrip()
+        if (i := remaining.find("]")) != -1:
+            list_output.append(cls.parse_list_element(remaining[:i]))
+            remaining = remaining[i + 1 :].lstrip()
+        else:
+            raise ValueError("Missing closing ']' in list expression")
+        return list_output

daq_config_server/client.py

@@ -0,0 +1,87 @@
+import json
+from http.client import HTTPConnection, HTTPSConnection
+from logging import Logger, getLogger
+from typing import TypeVar
+
+from urllib3.util import parse_url
+
+from .constants import ENDPOINTS
+
+T = TypeVar("T")
+
+
+class ConfigServer:
+    def __init__(self, url: str, log: Logger | None = None) -> None:
+        self._url = parse_url(url)
+        self._uri_prefix = self._url.request_uri if self._url.request_uri != "/" else ""
+        if self._url.scheme != "http" and self._url.scheme != "https":
+            raise ValueError("ConfigServer must use HTTP or HTTPS!")
+        self._Conn = HTTPSConnection if self._url.scheme == "https" else HTTPConnection
+        self._log = log if log else getLogger("daq_config_server.client")
+
+    def _get(
+        self,
+        endpoint: str,
+        item: str | None = None,
+        options: dict[str, str] | None = None,
+    ):
+        req_item = f"/{item}" if item else ""
+        conn = self._Conn(self._url.host, self._url.port or self._url.scheme)
+        req_ops = (
+            f"?{''.join(f'{k}={v}&' for k,v in options.items())}"[:-1]
+            if options
+            else ""
+        )
+        complete_req = self._uri_prefix + endpoint + req_item + req_ops
+        conn.connect()
+        conn.request("GET", complete_req)
+        resp = conn.getresponse()
+        assert resp.status == 200, f"Failed to get response: {resp!r}"
+        body = json.loads(resp.read())
+        assert item in body, f"Malformed response: {body} does not contain {item}"
+        resp.close()
+        conn.close()
+        return body[item]
+
+    def get_beamline_param(self, param: str) -> str | int | float | bool | None:
+        return self._get(ENDPOINTS.BL_PARAM, param)
+
+    def get_feature_flag(self, flag_name: str) -> bool | None:
+        """Get the specified feature flag; returns None if it does not exist. Will check
+        that the HTTP response is correct and raise an AssertionError if not."""
+        return self._get(ENDPOINTS.FEATURE, flag_name)
+
+    def get_all_feature_flags(self) -> dict | None:
+        """Get the values for all flags; returns None if it does not exist. Will check
+        that the HTTP response is correct and raise an AssertionError if not."""
+        return self._get(ENDPOINTS.FEATURE, options={"get_values": "true"})
+
+    def get_feature_flag_list(self) -> list[str]:
+        """Get the list of all feature flags. Will check that the HTTP response is
+        correct and raise an AssertionError if not."""
+        return self._get(ENDPOINTS.FEATURE)
+
+    def best_effort_get_feature_flag(
+        self, flag_name: str, fallback: T = None
+    ) -> bool | T:
+        """Get the specified feature flag, returns fallback value (default None) if it
+        doesn't exist or if there is a connection error - in the latter case logs to
+        error."""
+        try:
+            return self._get(ENDPOINTS.FEATURE, flag_name)
+        except (AssertionError, OSError):
+            self._log.error(
+                "Encountered an error reading from the config service.", exc_info=True
+            )
+            return fallback
+
+    def best_effort_get_all_feature_flags(self) -> dict[str, bool]:
+        """Get all flags, returns an empty dict if there are no flags, or if there
+        is a connection error - in the latter case logs to error."""
+        try:
+            return self._get(ENDPOINTS.FEATURE, options={"get_values": "true"})
+        except (AssertionError, OSError):
+            self._log.error(
+                "Encountered an error reading from the config service.", exc_info=True
+            )
+            return {}

daq_config_server/constants.py

@@ -0,0 +1,18 @@
+from dataclasses import dataclass
+
+
+@dataclass(frozen=True)
+class Endpoints:
+    FEATURE = "/featureflag"
+    FEATURE_DISALLOWED_SPECIALS = ["all"]
+    BL_PARAM = "/beamlineparameters"
+    INFO = "/info"
+
+
+@dataclass(frozen=True)
+class DatabaseKeys:
+    FEATURE_SET = "featureflags"
+
+
+DATABASE_KEYS = DatabaseKeys()
+ENDPOINTS = Endpoints()

daq_config_server-0.1.0.dist-info/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

daq_config_server-0.1.0.dist-info/METADATA

@@ -0,0 +1,306 @@
+Metadata-Version: 2.1
+Name: daq-config-server
+Version: 0.1.0
+Summary: A service to put and get your config values from
+Author-email: David Perl <david.perl@diamond.ac.uk>
+License: Apache License
+                                   Version 2.0, January 2004
+                                http://www.apache.org/licenses/
+        
+           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+        
+           1. Definitions.
+        
+              "License" shall mean the terms and conditions for use, reproduction,
+              and distribution as defined by Sections 1 through 9 of this document.
+        
+              "Licensor" shall mean the copyright owner or entity authorized by
+              the copyright owner that is granting the License.
+        
+              "Legal Entity" shall mean the union of the acting entity and all
+              other entities that control, are controlled by, or are under common
+              control with that entity. For the purposes of this definition,
+              "control" means (i) the power, direct or indirect, to cause the
+              direction or management of such entity, whether by contract or
+              otherwise, or (ii) ownership of fifty percent (50%) or more of the
+              outstanding shares, or (iii) beneficial ownership of such entity.
+        
+              "You" (or "Your") shall mean an individual or Legal Entity
+              exercising permissions granted by this License.
+        
+              "Source" form shall mean the preferred form for making modifications,
+              including but not limited to software source code, documentation
+              source, and configuration files.
+        
+              "Object" form shall mean any form resulting from mechanical
+              transformation or translation of a Source form, including but
+              not limited to compiled object code, generated documentation,
+              and conversions to other media types.
+        
+              "Work" shall mean the work of authorship, whether in Source or
+              Object form, made available under the License, as indicated by a
+              copyright notice that is included in or attached to the work
+              (an example is provided in the Appendix below).
+        
+              "Derivative Works" shall mean any work, whether in Source or Object
+              form, that is based on (or derived from) the Work and for which the
+              editorial revisions, annotations, elaborations, or other modifications
+              represent, as a whole, an original work of authorship. For the purposes
+              of this License, Derivative Works shall not include works that remain
+              separable from, or merely link (or bind by name) to the interfaces of,
+              the Work and Derivative Works thereof.
+        
+              "Contribution" shall mean any work of authorship, including
+              the original version of the Work and any modifications or additions
+              to that Work or Derivative Works thereof, that is intentionally
+              submitted to Licensor for inclusion in the Work by the copyright owner
+              or by an individual or Legal Entity authorized to submit on behalf of
+              the copyright owner. For the purposes of this definition, "submitted"
+              means any form of electronic, verbal, or written communication sent
+              to the Licensor or its representatives, including but not limited to
+              communication on electronic mailing lists, source code control systems,
+              and issue tracking systems that are managed by, or on behalf of, the
+              Licensor for the purpose of discussing and improving the Work, but
+              excluding communication that is conspicuously marked or otherwise
+              designated in writing by the copyright owner as "Not a Contribution."
+        
+              "Contributor" shall mean Licensor and any individual or Legal Entity
+              on behalf of whom a Contribution has been received by Licensor and
+              subsequently incorporated within the Work.
+        
+           2. Grant of Copyright License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              copyright license to reproduce, prepare Derivative Works of,
+              publicly display, publicly perform, sublicense, and distribute the
+              Work and such Derivative Works in Source or Object form.
+        
+           3. Grant of Patent License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              (except as stated in this section) patent license to make, have made,
+              use, offer to sell, sell, import, and otherwise transfer the Work,
+              where such license applies only to those patent claims licensable
+              by such Contributor that are necessarily infringed by their
+              Contribution(s) alone or by combination of their Contribution(s)
+              with the Work to which such Contribution(s) was submitted. If You
+              institute patent litigation against any entity (including a
+              cross-claim or counterclaim in a lawsuit) alleging that the Work
+              or a Contribution incorporated within the Work constitutes direct
+              or contributory patent infringement, then any patent licenses
+              granted to You under this License for that Work shall terminate
+              as of the date such litigation is filed.
+        
+           4. Redistribution. You may reproduce and distribute copies of the
+              Work or Derivative Works thereof in any medium, with or without
+              modifications, and in Source or Object form, provided that You
+              meet the following conditions:
+        
+              (a) You must give any other recipients of the Work or
+                  Derivative Works a copy of this License; and
+        
+              (b) You must cause any modified files to carry prominent notices
+                  stating that You changed the files; and
+        
+              (c) You must retain, in the Source form of any Derivative Works
+                  that You distribute, all copyright, patent, trademark, and
+                  attribution notices from the Source form of the Work,
+                  excluding those notices that do not pertain to any part of
+                  the Derivative Works; and
+        
+              (d) If the Work includes a "NOTICE" text file as part of its
+                  distribution, then any Derivative Works that You distribute must
+                  include a readable copy of the attribution notices contained
+                  within such NOTICE file, excluding those notices that do not
+                  pertain to any part of the Derivative Works, in at least one
+                  of the following places: within a NOTICE text file distributed
+                  as part of the Derivative Works; within the Source form or
+                  documentation, if provided along with the Derivative Works; or,
+                  within a display generated by the Derivative Works, if and
+                  wherever such third-party notices normally appear. The contents
+                  of the NOTICE file are for informational purposes only and
+                  do not modify the License. You may add Your own attribution
+                  notices within Derivative Works that You distribute, alongside
+                  or as an addendum to the NOTICE text from the Work, provided
+                  that such additional attribution notices cannot be construed
+                  as modifying the License.
+        
+              You may add Your own copyright statement to Your modifications and
+              may provide additional or different license terms and conditions
+              for use, reproduction, or distribution of Your modifications, or
+              for any such Derivative Works as a whole, provided Your use,
+              reproduction, and distribution of the Work otherwise complies with
+              the conditions stated in this License.
+        
+           5. Submission of Contributions. Unless You explicitly state otherwise,
+              any Contribution intentionally submitted for inclusion in the Work
+              by You to the Licensor shall be under the terms and conditions of
+              this License, without any additional terms or conditions.
+              Notwithstanding the above, nothing herein shall supersede or modify
+              the terms of any separate license agreement you may have executed
+              with Licensor regarding such Contributions.
+        
+           6. Trademarks. This License does not grant permission to use the trade
+              names, trademarks, service marks, or product names of the Licensor,
+              except as required for reasonable and customary use in describing the
+              origin of the Work and reproducing the content of the NOTICE file.
+        
+           7. Disclaimer of Warranty. Unless required by applicable law or
+              agreed to in writing, Licensor provides the Work (and each
+              Contributor provides its Contributions) on an "AS IS" BASIS,
+              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+              implied, including, without limitation, any warranties or conditions
+              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+              PARTICULAR PURPOSE. You are solely responsible for determining the
+              appropriateness of using or redistributing the Work and assume any
+              risks associated with Your exercise of permissions under this License.
+        
+           8. Limitation of Liability. In no event and under no legal theory,
+              whether in tort (including negligence), contract, or otherwise,
+              unless required by applicable law (such as deliberate and grossly
+              negligent acts) or agreed to in writing, shall any Contributor be
+              liable to You for damages, including any direct, indirect, special,
+              incidental, or consequential damages of any character arising as a
+              result of this License or out of the use or inability to use the
+              Work (including but not limited to damages for loss of goodwill,
+              work stoppage, computer failure or malfunction, or any and all
+              other commercial damages or losses), even if such Contributor
+              has been advised of the possibility of such damages.
+        
+           9. Accepting Warranty or Additional Liability. While redistributing
+              the Work or Derivative Works thereof, You may choose to offer,
+              and charge a fee for, acceptance of support, warranty, indemnity,
+              or other liability obligations and/or rights consistent with this
+              License. However, in accepting such obligations, You may act only
+              on Your own behalf and on Your sole responsibility, not on behalf
+              of any other Contributor, and only if You agree to indemnify,
+              defend, and hold each Contributor harmless for any liability
+              incurred by, or claims asserted against, such Contributor by reason
+              of your accepting any such warranty or additional liability.
+        
+           END OF TERMS AND CONDITIONS
+        
+           APPENDIX: How to apply the Apache License to your work.
+        
+              To apply the Apache License to your work, attach the following
+              boilerplate notice, with the fields enclosed by brackets "{}"
+              replaced with your own identifying information. (Don't include
+              the brackets!)  The text should be enclosed in the appropriate
+              comment syntax for the file format. We also recommend that a
+              file or class name and description of purpose be included on the
+              same "printed page" as the copyright notice for easier
+              identification within third-party archives.
+        
+           Copyright {yyyy} {name of copyright owner}
+        
+           Licensed under the Apache License, Version 2.0 (the "License");
+           you may not use this file except in compliance with the License.
+           You may obtain a copy of the License at
+        
+               http://www.apache.org/licenses/LICENSE-2.0
+        
+           Unless required by applicable law or agreed to in writing, software
+           distributed under the License is distributed on an "AS IS" BASIS,
+           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+           See the License for the specific language governing permissions and
+           limitations under the License.
+        
+Project-URL: GitHub, https://github.com/DiamondLightSource/daq-config-server
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: copier ; extra == 'dev'
+Requires-Dist: httpx ; extra == 'dev'
+Requires-Dist: mockito ; extra == 'dev'
+Requires-Dist: pipdeptree ; extra == 'dev'
+Requires-Dist: pre-commit ; extra == 'dev'
+Requires-Dist: pyright ; extra == 'dev'
+Requires-Dist: pytest ; extra == 'dev'
+Requires-Dist: pytest-cov ; extra == 'dev'
+Requires-Dist: pytest-asyncio ; extra == 'dev'
+Requires-Dist: ruff ; extra == 'dev'
+Requires-Dist: tox-direct ; extra == 'dev'
+Requires-Dist: types-mock ; extra == 'dev'
+Provides-Extra: server
+Requires-Dist: fastapi ; extra == 'server'
+Requires-Dist: redis ; extra == 'server'
+Requires-Dist: hiredis ; extra == 'server'
+
+[![Frontend CI](https://github.com/DiamondLightSource/daq-config-server/actions/workflows/gui_ci.yml/badge.svg)](https://github.com/DiamondLightSource/daq-config-server/actions/workflows/gui_ci.yml)
+[![Backend CI](https://github.com/DiamondLightSource/daq-config-server/actions/workflows/backend_ci.yml/badge.svg)](https://github.com/DiamondLightSource/daq-config-server/actions/workflows/backend_ci.yml)
+[![Coverage](https://codecov.io/gh/DiamondLightSource/daq-config-server/branch/main/graph/badge.svg)](https://codecov.io/gh/DiamondLightSource/daq-config-server)
+[![PyPI](https://img.shields.io/pypi/v/daq-config-server.svg)](https://pypi.org/project/daq-config-server)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+
+# DAQ Config Server
+
+A service to put and get your config values from.
+
+Comprises a FastAPI backend with a valkey database to C/R/U/D config values, and a Chakra/React frontend for easier management.
+
+Currently the scope is JUST storing and retrieving feature flags for Hyperion/I03 UDC but we hope to expand this to replace all DAQ config files.
+
+|  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> |
+
+A simple app for storing and fetching values. Has a Valkey (Redis) instance as well as options for file-backed legacy
+values (e.g. `beamlineParameters`...)
+
+Currently the server application always needs to be run with the `--dev` flag, as it cannot yet look at the DLS
+filesystem to find the real beamline parameter files.
+
+To use the config values in an experimental application (e.g. Hyperion) you can do:
+
+```python
+from daq_config_server.client import ConfigServer
+
+config_server = ConfigServer("<service ip address>", <port>)
+
+use_stub_offsets: bool = config_server.best_effort_get_feature_flag("use_stub_offsets")
+
+```
+
+To work on the GUI you will probably need to run:
+
+```bash
+module load node
+npm install
+```
+
+in the gui directory to setup the environment.
+
+## Testing and deployment
+
+There is a convenient script in `./deployment/build_and_push_all.sh` to build all the containers, which takes
+a `--dev` option to push containers with `-dev` appended to their names and a `--no-push` option for local
+development. This ensures that environment variables for dev or prod builds are included in the built container,
+such as the GUI pointing at the subdomain URL vs. localhost, and the `root_path` of the FastAPI app. To push to
+the registry you must have identified to gcloud by having loaded a kubernetes module and running `gcloud auth login.`
+
+To deploy a live version, you can run the above script with no arguments and then while logged in to
+argus, in the `daq-config-server` namespace, run `kubectl rollout restart deployment`. If it is not
+currently deploy it you can deploy it with `helm install daq-config ./helmchart`.
+
+To test locally, you can build everything with `./deployment/build_and_push_all.sh --dev --no-push` and then
+run the containers `daq-config-server-dev` (with the command `daq-config-server --dev`), `daq-config-server-db-dev`,
+and `daq-config-server-gui-dev`, all with the `--net host` option.
+
+To test on pollux, log in to pollux in your namespace and run:
+
+```bash
+helm install daq-config ./helmchart/ --values dev-values.yaml
+```
+
+followed by:
+
+```bash
+kubectl port-forward service/daq-config-server-svc 8080 8555
+```
+
+after which you should be able to access the frontend on `http://localhost:8080` and the API on `http://localhost:8555`

daq_config_server-0.1.0.dist-info/RECORD

@@ -0,0 +1,13 @@
+daq_config_server/__init__.py,sha256=v-rRiDOgZ3sQSMQKq0vgUQZvpeOkoHFXissAx6Ktg84,61
+daq_config_server/__main__.py,sha256=JOim5VGuFF4gB8aig5VvnBfdVZGTTNvf1Jbdpqdx-CY,896
+daq_config_server/_version.py,sha256=IMl2Pr_Sy4LVRKy_Sm4CdwUl1Gryous6ncL96EMYsnM,411
+daq_config_server/app.py,sha256=YAQluKu99f3uJyhfjkGLXRQ7pFBcckTMyWho6K8myDE,4923
+daq_config_server/beamline_parameters.py,sha256=5VQHEdETJSX6wpGwR2bd7IT-fPZx8rotvtXTbw3aKRs,2955
+daq_config_server/client.py,sha256=5ph8nnBbw_aegisr0J_zl9yZOGw4nYSeFbjhZJFAyFg,3607
+daq_config_server/constants.py,sha256=d4K24-VhLskmAExg99ilR2hMm9MSwZv2MmK8tuc4Jjw,340
+daq_config_server-0.1.0.dist-info/LICENSE,sha256=tAkwu8-AdEyGxGoSvJ2gVmQdcicWw3j1ZZueVV74M-E,11357
+daq_config_server-0.1.0.dist-info/METADATA,sha256=AXK7EfggStHB23tSU9aWfhxjyawL68hxIB1ZgMB3k1M,17849
+daq_config_server-0.1.0.dist-info/WHEEL,sha256=R0nc6qTxuoLk7ShA2_Y-UWkN8ZdfDBG2B6Eqpz2WXbs,91
+daq_config_server-0.1.0.dist-info/entry_points.txt,sha256=cv-mlPEaeKFDvkZevDoTTC-Bc-YJZoF1FYdCNTD-GjQ,70
+daq_config_server-0.1.0.dist-info/top_level.txt,sha256=Dj3b5P7chuN_BcLNuGa7fG9tjPm7vIilfwb_gBAmfz4,18
+daq_config_server-0.1.0.dist-info/RECORD,,

daq_config_server-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (72.1.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

daq_config_server-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+daq-config-server = daq_config_server.__main__:main

daq_config_server-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+daq_config_server