analogcloud-common 0.1.4__tar.gz

analogcloud_common-0.1.4/PKG-INFO

@@ -0,0 +1,71 @@
+Metadata-Version: 2.1
+Name: analogcloud-common
+Version: 0.1.4
+Summary: Common data models and storage components for Analog Cloud
+Author-Email: Anabrid <info@anabrid.com>
+Requires-Python: <4.0,>=3.11
+Requires-Dist: pydantic<3.0.0,>=2.0.0
+Requires-Dist: celery<6.0.0,>=5.3.0
+Requires-Dist: numpy>=2.4
+Requires-Dist: pybrid-computing>=0.12.6
+Requires-Dist: pybrid-computing-native>=0.12.6
+Requires-Dist: pyredacc>=0.11.7
+Requires-Dist: sympy>=1.13.3
+Requires-Dist: sqlalchemy[asyncio]>=2.0
+Requires-Dist: asyncpg>=0.29
+Requires-Dist: alembic>=1.13
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: jinja2>=3.1
+Requires-Dist: aioboto3>=15.5.0
+Description-Content-Type: text/markdown
+
+# Models
+
+This component contains data models that are used to communicate between
+at least two different components of the project.
+
+This includes the following models:
+- `database`: models/classes for interfacing with hot and cold storage
+  - `hot`: use plain Python classes that abstract away the path variables and include static types
+  - `cold`: data models in SQL alchemy
+
+Note that the `hot` storage essentially caches parts of the data structures
+of the `cold` storage. This should be reflected in the SQL alchemy model: 
+
+## Principles
+
+- make sure to use object-oriented expressons and techniques, for example
+abstract models and classes which have different implementations to account for versioning.
+- consider the fact that the API itself is mostly consisting of CRUD-type of endpoints
+- for hot storage, favor small field with primitive data types
+- for cold storage, prefer large objects that enable fast data read without too many joins
+when reading/writing through the API endpoints
+
+## Modelled data
+
+This is a very rough first draft which does _not_ correspond to an 1:1 ORM:
+
+**Cold storage**
+- run 
+    - id
+    - type of job (compile, run, verify...)
+    - state changes (array of timestamp/status)
+    - logs
+    - number of channels
+    - measurements (per channel) for run/verify jobs
+    - device id
+    - input type
+    - input (JSON data)
+    - output (JSON data)
+- device
+    - id
+    - type
+    - input type
+    - parameter schema (as a data type that will simplify the model checking later)
+
+**Hot storage**
+- run (by UUID)
+  - state changes (array of pairs timestamp/status)
+  - logs (array of lines, lines are appended)
+  - measurements (on different channels, each channel is a time series of floating point values)
+- list of active devices (device IDs), regularly updated from scanner

analogcloud_common-0.1.4/README.md

@@ -0,0 +1,50 @@
+# Models
+
+This component contains data models that are used to communicate between
+at least two different components of the project.
+
+This includes the following models:
+- `database`: models/classes for interfacing with hot and cold storage
+  - `hot`: use plain Python classes that abstract away the path variables and include static types
+  - `cold`: data models in SQL alchemy
+
+Note that the `hot` storage essentially caches parts of the data structures
+of the `cold` storage. This should be reflected in the SQL alchemy model: 
+
+## Principles
+
+- make sure to use object-oriented expressons and techniques, for example
+abstract models and classes which have different implementations to account for versioning.
+- consider the fact that the API itself is mostly consisting of CRUD-type of endpoints
+- for hot storage, favor small field with primitive data types
+- for cold storage, prefer large objects that enable fast data read without too many joins
+when reading/writing through the API endpoints
+
+## Modelled data
+
+This is a very rough first draft which does _not_ correspond to an 1:1 ORM:
+
+**Cold storage**
+- run 
+    - id
+    - type of job (compile, run, verify...)
+    - state changes (array of timestamp/status)
+    - logs
+    - number of channels
+    - measurements (per channel) for run/verify jobs
+    - device id
+    - input type
+    - input (JSON data)
+    - output (JSON data)
+- device
+    - id
+    - type
+    - input type
+    - parameter schema (as a data type that will simplify the model checking later)
+
+**Hot storage**
+- run (by UUID)
+  - state changes (array of pairs timestamp/status)
+  - logs (array of lines, lines are appended)
+  - measurements (on different channels, each channel is a time series of floating point values)
+- list of active devices (device IDs), regularly updated from scanner

analogcloud_common-0.1.4/pyproject.toml

@@ -0,0 +1,80 @@
+[build-system]
+requires = [
+    "pdm-backend",
+]
+build-backend = "pdm.backend"
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = [
+    "tests",
+]
+pythonpath = [
+    "src",
+]
+python_classes = [
+    "Test*",
+    "!_*",
+]
+python_functions = [
+    "test_*",
+]
+markers = [
+    "integration: cross-process / live-infrastructure tests (require Docker)",
+]
+
+[tool.black]
+line-length = 88
+target-version = [
+    "py313",
+]
+
+[tool.ruff]
+line-length = 88
+target-version = "py313"
+
+[tool.pdm.build]
+includes = [
+    "src/anabrid",
+]
+
+[tool.uv]
+prerelease = "allow"
+
+[project]
+authors = [
+    { name = "Anabrid", email = "info@anabrid.com" },
+]
+requires-python = "<4.0,>=3.11"
+dependencies = [
+    "pydantic<3.0.0,>=2.0.0",
+    "celery<6.0.0,>=5.3.0",
+    "numpy>=2.4",
+    "pybrid-computing>=0.12.6",
+    "pybrid-computing-native>=0.12.6",
+    "pyredacc>=0.11.7",
+    "sympy>=1.13.3",
+    "sqlalchemy[asyncio]>=2.0",
+    "asyncpg>=0.29",
+    "alembic>=1.13",
+    "pyyaml>=6.0",
+    "jinja2>=3.1",
+    "aioboto3>=15.5.0",
+]
+name = "analogcloud-common"
+version = "0.1.4"
+description = "Common data models and storage components for Analog Cloud"
+readme = "README.md"
+
+[project.scripts]
+analogcloud-deploy = "anabrid.cloud.deploy.generate:main"
+
+[dependency-groups]
+dev = [
+    "pytest<8.0.0,>=7.0.0",
+    "pytest-asyncio<1.0.0,>=0.21.0",
+    "black>=24.0.0",
+    "ruff<1.0.0,>=0.0.280",
+    "psycopg[binary]>=3.1",
+    "testcontainers>=4.15.0rc2",
+]