rcdb 2.2.10__tar.gz → 2.3.1__tar.gz

{rcdb-2.2.10 → rcdb-2.3.1}/MANIFEST.in

@@ -1,12 +1,12 @@
-exclude .gitignore
-exclude daq
-exclude examples
-exclude halld_rcdb
-exclude tests
-exclude utilites
-
-
-include ../README.md
-recursive-include rcdb *.py
-recursive-include rcdb/web/static *
+exclude .gitignore
+exclude daq
+exclude examples
+exclude halld_rcdb
+exclude tests
+exclude utilites
+
+
+include ../README.md
+recursive-include rcdb *.py
+recursive-include rcdb/web/static *
 recursive-include rcdb/web/templates *

{rcdb-2.2.10/rcdb.egg-info → rcdb-2.3.1}/PKG-INFO

@@ -1,56 +1,66 @@
-Metadata-Version: 2.4
-Name: rcdb
-Version: 2.2.10
-Summary: RCDB - Run Conditions DataBase
-Author-email: Dmitry Romanov <romanov@jlab.org>
-License-Expression: MIT
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: Implementation :: CPython
-Classifier: Intended Audience :: Science/Research
-Classifier: Intended Audience :: Developers
-Classifier: Operating System :: OS Independent
-Classifier: Topic :: Scientific/Engineering :: Physics
-Classifier: Topic :: Database
-Requires-Python: >=3.9
-Description-Content-Type: text/markdown
-Requires-Dist: markupsafe>=3.0
-Requires-Dist: pymysql>=1.1
-Requires-Dist: ply>=3.11
-Requires-Dist: mako>=1.3
-Requires-Dist: click>=8
-Requires-Dist: sqlalchemy>=2
-Requires-Dist: flask>=3.1.0
-Requires-Dist: rich
-
-## RCDB
-
-![Python tests](https://github.com/JeffersonLab/rcdb/actions/workflows/python-tests.yml/badge.svg)
-[![Python examples work](https://github.com/JeffersonLab/rcdb/actions/workflows/python-examples.yml/badge.svg)](https://github.com/JeffersonLab/rcdb/actions/workflows/python-examples.yml)
-
-Run Configuration/Conditions Database (RCDB) stores run related information and conditions. It uses MySQL or SQLite databases to store information about runs and provides interfaces to search runs, manage data, automatic CODA integration, etc. 
-
-The interfaces available are:  
-- Web site
-- Command line interface (CLI)
-- Python API
-- C++ API
-- Possibly JAVA API
-
-#### Documentation:
-
-https://jeffersonlab.github.io/rcdb/
-
-#### Demo website:
-One can visit HallD RCDB Web site as demo:  
-https://halldweb.jlab.org/rcdb/
-
-
-#### SQLite db:
-Daily updated SQLite database is available here:  
-https://halldweb.jlab.org/dist/rcdb2.sqlite
+Metadata-Version: 2.4
+Name: rcdb
+Version: 2.3.1
+Summary: RCDB - Run Conditions DataBase
+Author-email: Dmitry Romanov <romanov@jlab.org>
+License-Expression: MIT
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: Topic :: Database
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: markupsafe>=3.0
+Requires-Dist: pymysql>=1.1
+Requires-Dist: ply>=3.11
+Requires-Dist: mako>=1.3
+Requires-Dist: click>=8
+Requires-Dist: sqlalchemy>=2
+Requires-Dist: flask>=3.1.0
+Requires-Dist: rich
+Provides-Extra: examples
+Requires-Dist: jsonpickle; extra == "examples"
+Requires-Dist: pandas; extra == "examples"
+Provides-Extra: dev
+Requires-Dist: pyflakes>=3; extra == "dev"
+
+## RCDB
+
+![Python tests](https://github.com/JeffersonLab/rcdb/actions/workflows/python-tests.yml/badge.svg)
+[![Python examples work](https://github.com/JeffersonLab/rcdb/actions/workflows/python-examples.yml/badge.svg)](https://github.com/JeffersonLab/rcdb/actions/workflows/python-examples.yml)
+[![C++ tests](https://github.com/JeffersonLab/rcdb/actions/workflows/cpp-tests.yml/badge.svg)](https://github.com/JeffersonLab/rcdb/actions/workflows/cpp-tests.yml)
+[![C++ examples](https://github.com/JeffersonLab/rcdb/actions/workflows/cpp-examples.yml/badge.svg)](https://github.com/JeffersonLab/rcdb/actions/workflows/cpp-examples.yml)
+[![Documentation](https://github.com/JeffersonLab/rcdb/actions/workflows/documentation.yml/badge.svg)](https://github.com/JeffersonLab/rcdb/actions/workflows/documentation.yml)
+
+Run Configuration/Conditions Database (RCDB) stores run related information and conditions. 
+It uses MySQL or SQLite databases to store information about runs and provides interfaces to search runs, manage data, automatic CODA integration, etc. 
+
+The interfaces available are:  
+- Web
+- Command line interface (CLI)
+- Python API
+- C++ API
+- Possibly JAVA API
+
+#### Documentation:
+
+https://jeffersonlab.github.io/rcdb/
+
+#### Demo website:
+One can visit HallD RCDB Web site as demo:  
+https://halldweb.jlab.org/rcdb/
+
+
+#### SQLite db:
+Daily updated SQLite database is available here:  
+https://halldweb.jlab.org/dist/rcdb.sqlite

rcdb-2.3.1/README.md

@@ -0,0 +1,30 @@
+## RCDB
+
+![Python tests](https://github.com/JeffersonLab/rcdb/actions/workflows/python-tests.yml/badge.svg)
+[![Python examples work](https://github.com/JeffersonLab/rcdb/actions/workflows/python-examples.yml/badge.svg)](https://github.com/JeffersonLab/rcdb/actions/workflows/python-examples.yml)
+[![C++ tests](https://github.com/JeffersonLab/rcdb/actions/workflows/cpp-tests.yml/badge.svg)](https://github.com/JeffersonLab/rcdb/actions/workflows/cpp-tests.yml)
+[![C++ examples](https://github.com/JeffersonLab/rcdb/actions/workflows/cpp-examples.yml/badge.svg)](https://github.com/JeffersonLab/rcdb/actions/workflows/cpp-examples.yml)
+[![Documentation](https://github.com/JeffersonLab/rcdb/actions/workflows/documentation.yml/badge.svg)](https://github.com/JeffersonLab/rcdb/actions/workflows/documentation.yml)
+
+Run Configuration/Conditions Database (RCDB) stores run related information and conditions. 
+It uses MySQL or SQLite databases to store information about runs and provides interfaces to search runs, manage data, automatic CODA integration, etc. 
+
+The interfaces available are:  
+- Web
+- Command line interface (CLI)
+- Python API
+- C++ API
+- Possibly JAVA API
+
+#### Documentation:
+
+https://jeffersonlab.github.io/rcdb/
+
+#### Demo website:
+One can visit HallD RCDB Web site as demo:  
+https://halldweb.jlab.org/rcdb/
+
+
+#### SQLite db:
+Daily updated SQLite database is available here:  
+https://halldweb.jlab.org/dist/rcdb.sqlite

{rcdb-2.2.10 → rcdb-2.3.1}/pyproject.toml

@@ -1,67 +1,73 @@
-[build-system]
-# These tell pip or other installers how to build your project
-requires = [
-    "setuptools>=61.0",  # version 61+ supports PEP 621 metadata in pyproject.toml
-    "wheel"
-]
-build-backend = "setuptools.build_meta"
-
-[project]
-name = "rcdb"
-description = "RCDB - Run Conditions DataBase"
-# If you want to read your long description from README.md, you can also do:
-readme = "README.md"
-# If you'd like to keep version in rcdb.version.py, see "Dynamic version" section below.
-# Otherwise, put a fixed version here, e.g. version = "1.0.0"
-dynamic = ["version"]
-license = "MIT"
-authors = [
-    { name="Dmitry Romanov", email="romanov@jlab.org" }
-]
-classifiers = [
-    "Development Status :: 5 - Production/Stable",
-    "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.9",
-    "Programming Language :: Python :: 3.10",
-    "Programming Language :: Python :: 3.11",
-    "Programming Language :: Python :: 3.12",
-    "Programming Language :: Python :: 3.13",
-    "Programming Language :: Python :: Implementation :: CPython",
-    "Intended Audience :: Science/Research",
-    "Intended Audience :: Developers",
-    "Operating System :: OS Independent",
-    "Topic :: Scientific/Engineering :: Physics",
-    "Topic :: Database"
-]
-requires-python = ">=3.9"
-dependencies = [
-    "markupsafe>=3.0",
-    "pymysql>=1.1",
-    "ply>=3.11",
-    "mako>=1.3",
-    "click>=8",
-    "sqlalchemy>=2",
-    "flask>=3.1.0",
-    "rich"
-]
-
-# If you want a console script, define it in [project.scripts]
-[project.scripts]
-rcdb = "rcdb.cli.app:rcdb_cli"
-
-# Tell setuptools how to find your packages if needed:
-[tool.setuptools.packages.find]
-include = ["rcdb*"]
-
-[tool.setuptools]
-include-package-data = true
-
-[tool.setuptools.package-data]
-# Recursively include everything under rcdb/web/static/ and rcdb/web/templates/
-rcdb = [
-    "web/static/**/*.*",
-    "web/templates/**/*.*"
-]
-
-[tool.setuptools.dynamic]
-version = { attr = "rcdb.version.version" }
+[build-system]
+# These tell pip or other installers how to build your project
+requires = [
+    "setuptools>=61.0",  # version 61+ supports PEP 621 metadata in pyproject.toml
+    "wheel"
+]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "rcdb"
+description = "RCDB - Run Conditions DataBase"
+# If you want to read your long description from README.md, you can also do:
+readme = "README.md"
+# If you'd like to keep version in rcdb.version.py, see "Dynamic version" section below.
+# Otherwise, put a fixed version here, e.g. version = "1.0.0"
+dynamic = ["version"]
+license = "MIT"
+authors = [
+    { name="Dmitry Romanov", email="romanov@jlab.org" }
+]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: Implementation :: CPython",
+    "Intended Audience :: Science/Research",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Topic :: Scientific/Engineering :: Physics",
+    "Topic :: Database"
+]
+requires-python = ">=3.9"
+dependencies = [
+    "markupsafe>=3.0",
+    "pymysql>=1.1",
+    "ply>=3.11",
+    "mako>=1.3",
+    "click>=8",
+    "sqlalchemy>=2",
+    "flask>=3.1.0",
+    "rich"
+]
+
+[project.optional-dependencies]
+examples = ["jsonpickle", "pandas"]
+dev = ["pyflakes>=3"]
+
+
+# If you want a console script, define it in [project.scripts]
+[project.scripts]
+rcdb = "rcdb.cli.app:rcdb_cli"
+
+# Tell setuptools how to find your packages if needed:
+[tool.setuptools.packages.find]
+include = ["rcdb*"]
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.package-data]
+# Recursively include everything under rcdb/web/static/ and rcdb/web/templates/
+rcdb = [
+    "web/static/**/*.*",
+    "web/templates/**/*.*"
+]
+
+[tool.setuptools.dynamic]
+version = { attr = "rcdb.version.version" }

{rcdb-2.2.10 → rcdb-2.3.1}/rcdb/__init__.py

@@ -1,127 +1,137 @@
-from .model import ConditionType
-from .provider import RCDBProvider
-from .provider import ConfigurationProvider
-from .errors import *
-
-# This thing separates cells in data blob
-blob_delimiter = "|"
-
-# if cell of data table is a string and the string already contains blob_delimiter
-# we have to encode blob_delimiter to blob_delimiter_replace on data write and decode it bach on data read
-blob_delimiter_replacement = "&delimiter;"
-
-SQL_SCHEMA_VERSION = 2
-
-
-class UpdateReasons(object):
-    """Class holds a default values of UpdateContext.reason field
-    Attributes:
-        START -  means update goes after 'GO', beginning of the data taking
-        UPDATE - after run in started, RCDB is being update each minute. That is how it is done
-        END -    after run is ended
-        """
-    START = 'start'
-    UPDATE = 'update'
-    END = 'end'
-    UNKNOWN = ''
-
-
-# -------------------------------------------------
-# class holding a context of the update operations
-# -------------------------------------------------
-class UpdateContext(object):
-    """Updates context
-
-        Attributes:
-            self.db - RCDBProvider with connection
-            self.reason - one of UpdateReasons or empty string
-            self.run - Run object
-    """
-
-    def __init__(self, db, reason):
-        self.db = db
-        self.reason = reason  # Context in which daq is called '', 'start', 'update', 'end'
-        self.run = None       # Run object
-
-
-# -------------------------------------------------
-# function Convert list to DB text representation
-# -------------------------------------------------
-def list_to_db_text(values):
-    """
-    Converts list of values like pedestal,threshold,baseline_preset values
-    to a space separated string - that is how the values are stored in the DB
-
-    :param values: list of values
-    :type values: []
-
-    :return: string with values as it is stored in DB
-    :rtype: basestring
-    """
-    return " ".join([str(value) for value in values])
-
-
-def make_threshold_preset(db, board, values):
-    """
-    checks if values
-    :param values:
-    :return:
-    """
-
-    if isinstance(values, list):
-        text_values = list_to_db_text(values)
-
-
-class DefaultConditions(object):
-    """
-    Holds common names for conditions and can ensure database have them
-    """
-
-    EVENT_RATE = 'event_rate'
-    EVENT_COUNT = 'event_count'
-    RUN_TYPE = 'run_type'
-    RUN_CONFIG = 'run_config'
-    RUN_LENGTH = 'run_length'
-    RUN_START_TIME = 'run_start_time'
-    RUN_END_TIME = 'run_end_time'
-    DAQ_SETUP = 'daq_setup'
-    SESSION = 'session'
-    USER_COMMENT = 'user_comment'
-    COMPONENTS = 'components'
-    COMPONENT_STATS = 'component_stats'
-    RTVS = 'rtvs'
-    IS_VALID_RUN_END = 'is_valid_run_end'
-
-
-def create_default_condition_types(db):
-    """
-    Checks if condition types listed in class exist in the database and create them if not
-    :param db: RCDBProvider connected to database
-    :type db: RCDBProvider
-
-    :return: None
-    """
-    all_types_dict = {t.name: t for t in db.get_condition_types()}
-
-    def create_condition_type(name, value_type, description=""):
-        all_types_dict[name] if name in all_types_dict.keys() \
-            else db.create_condition_type(name, value_type, description)
-
-    # get or create condition type
-    create_condition_type(DefaultConditions.EVENT_RATE, ConditionType.FLOAT_FIELD, "Average event rate")
-    create_condition_type(DefaultConditions.EVENT_COUNT, ConditionType.INT_FIELD, "Number of events")
-    create_condition_type(DefaultConditions.RUN_TYPE, ConditionType.STRING_FIELD, "DAQ Run type")
-    create_condition_type(DefaultConditions.RUN_CONFIG, ConditionType.STRING_FIELD, "DAQ Run configuration")
-    create_condition_type(DefaultConditions.SESSION, ConditionType.STRING_FIELD)
-    create_condition_type(DefaultConditions.USER_COMMENT, ConditionType.STRING_FIELD)
-    create_condition_type(DefaultConditions.COMPONENTS, ConditionType.JSON_FIELD)
-    create_condition_type(DefaultConditions.RTVS, ConditionType.JSON_FIELD)
-    create_condition_type(DefaultConditions.COMPONENT_STATS, ConditionType.JSON_FIELD)
-    create_condition_type(DefaultConditions.IS_VALID_RUN_END, ConditionType.BOOL_FIELD,
-                          "True if a run has valid run-end record. "
-                          "False means the run was aborted/crashed at some point")
-    create_condition_type(DefaultConditions.RUN_LENGTH, ConditionType.INT_FIELD, "Length of the run ")
-    create_condition_type(DefaultConditions.RUN_START_TIME, ConditionType.TIME_FIELD, "Run start time ")
-    create_condition_type(DefaultConditions.RUN_END_TIME, ConditionType.TIME_FIELD, "Run end time (last CODA update)")
-
-
+from .model import ConditionType
+from .provider import RCDBProvider, ConfigurationProvider
+from .errors import (
+    OverrideConditionTypeError,
+    NoConditionTypeFound,
+    OverrideConditionValueError,
+    NoRunFoundError,
+    QueryFormatError,
+    QueryEvaluationError,
+    SqlSchemaVersionError,
+)
+
+# Names re-exported as part of rcdb's public API (e.g. rcdb.RCDBProvider)
+__all__ = [
+    "ConditionType",
+    "RCDBProvider",
+    "ConfigurationProvider",
+    "OverrideConditionTypeError",
+    "NoConditionTypeFound",
+    "OverrideConditionValueError",
+    "NoRunFoundError",
+    "QueryFormatError",
+    "QueryEvaluationError",
+    "SqlSchemaVersionError",
+]
+
+# This thing separates cells in data blob
+blob_delimiter = "|"
+
+# if cell of data table is a string and the string already contains blob_delimiter
+# we have to encode blob_delimiter to blob_delimiter_replace on data write and decode it bach on data read
+blob_delimiter_replacement = "&delimiter;"
+
+SQL_SCHEMA_VERSION = 2
+
+
+class UpdateReasons(object):
+    """Class holds a default values of UpdateContext.reason field
+    Attributes:
+        START -  means update goes after 'GO', beginning of the data taking
+        UPDATE - after run in started, RCDB is being update each minute. That is how it is done
+        END -    after run is ended
+        """
+    START = 'start'
+    UPDATE = 'update'
+    END = 'end'
+    UNKNOWN = ''
+
+
+# -------------------------------------------------
+# class holding a context of the update operations
+# -------------------------------------------------
+class UpdateContext(object):
+    """Updates context
+
+        Attributes:
+            self.db - RCDBProvider with connection
+            self.reason - one of UpdateReasons or empty string
+            self.run - Run object
+    """
+
+    def __init__(self, db, reason):
+        self.db = db
+        self.reason = reason  # Context in which daq is called '', 'start', 'update', 'end'
+        self.run = None       # Run object
+
+
+# -------------------------------------------------
+# function Convert list to DB text representation
+# -------------------------------------------------
+def list_to_db_text(values):
+    """
+    Converts list of values like pedestal,threshold,baseline_preset values
+    to a space separated string - that is how the values are stored in the DB
+
+    :param values: list of values
+    :type values: []
+
+    :return: string with values as it is stored in DB
+    :rtype: basestring
+    """
+    return " ".join([str(value) for value in values])
+
+
+class DefaultConditions(object):
+    """
+    Holds common names for conditions and can ensure database have them
+    """
+
+    EVENT_RATE = 'event_rate'
+    EVENT_COUNT = 'event_count'
+    RUN_TYPE = 'run_type'
+    RUN_CONFIG = 'run_config'
+    RUN_LENGTH = 'run_length'
+    RUN_START_TIME = 'run_start_time'
+    RUN_END_TIME = 'run_end_time'
+    DAQ_SETUP = 'daq_setup'
+    SESSION = 'session'
+    USER_COMMENT = 'user_comment'
+    COMPONENTS = 'components'
+    COMPONENT_STATS = 'component_stats'
+    RTVS = 'rtvs'
+    IS_VALID_RUN_END = 'is_valid_run_end'
+
+
+def create_default_condition_types(db):
+    """
+    Checks if condition types listed in class exist in the database and create them if not
+    :param db: RCDBProvider connected to database
+    :type db: RCDBProvider
+
+    :return: None
+    """
+    all_types_dict = {t.name: t for t in db.get_condition_types()}
+
+    def create_condition_type(name, value_type, description=""):
+        all_types_dict[name] if name in all_types_dict.keys() \
+            else db.create_condition_type(name, value_type, description)
+
+    # get or create condition type
+    create_condition_type(DefaultConditions.EVENT_RATE, ConditionType.FLOAT_FIELD, "Average event rate")
+    create_condition_type(DefaultConditions.EVENT_COUNT, ConditionType.INT_FIELD, "Number of events")
+    create_condition_type(DefaultConditions.RUN_TYPE, ConditionType.STRING_FIELD, "DAQ Run type")
+    create_condition_type(DefaultConditions.RUN_CONFIG, ConditionType.STRING_FIELD, "DAQ Run configuration")
+    create_condition_type(DefaultConditions.SESSION, ConditionType.STRING_FIELD)
+    create_condition_type(DefaultConditions.USER_COMMENT, ConditionType.STRING_FIELD)
+    create_condition_type(DefaultConditions.COMPONENTS, ConditionType.JSON_FIELD)
+    create_condition_type(DefaultConditions.RTVS, ConditionType.JSON_FIELD)
+    create_condition_type(DefaultConditions.COMPONENT_STATS, ConditionType.JSON_FIELD)
+    create_condition_type(DefaultConditions.IS_VALID_RUN_END, ConditionType.BOOL_FIELD,
+                          "True if a run has valid run-end record. "
+                          "False means the run was aborted/crashed at some point")
+    create_condition_type(DefaultConditions.RUN_LENGTH, ConditionType.INT_FIELD, "Length of the run ")
+    create_condition_type(DefaultConditions.RUN_START_TIME, ConditionType.TIME_FIELD, "Run start time ")
+    create_condition_type(DefaultConditions.RUN_END_TIME, ConditionType.TIME_FIELD, "Run end time (last CODA update)")
+
+

{rcdb-2.2.10 → rcdb-2.3.1}/rcdb/__main__.py

@@ -1,7 +1,7 @@
-# This is the same as rcdb.cli.api:rcdb_cli
-# The logic to have it here, is that if one uses:
-# python -m rcdb - it works like 'rcdb' command
-
-from rcdb.cli.app import rcdb_cli
-
-rcdb_cli(prog_name="rcdb")
+# This is the same as rcdb.cli.api:rcdb_cli
+# The logic to have it here, is that if one uses:
+# python -m rcdb - it works like 'rcdb' command
+
+from rcdb.cli.app import rcdb_cli
+
+rcdb_cli(prog_name="rcdb")