prisma-api 0.4.2__tar.gz → 0.4.4__tar.gz

{prisma_api-0.4.2 → prisma_api-0.4.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: prisma_api
-Version: 0.4.2
+Version: 0.4.4
 Summary: A package for interacting with PrISMa Platform APIs. PrISMa is a holistic system for numerical synthesis and assessment of Metal-Organic Frameworks and their applications, for Direct Air Capture of CO2. For more information, see: https://prisma.hw.ac.uk.
 Author-email: RCCS-CaptureTeam <team@prisma-platform.org>
 License: GNUv3
@@ -181,6 +181,7 @@ Module-level helpers exported from the package:
 - `prisma_api.update_dev_mode`
 - `prisma_api.update_dev_host_port`
 - `prisma_api.locate_config`
+- `prisma_api.PrismaUpsertError`, `prisma_api.PrismaRowErrorWarning`, `prisma_api.PrismaUnknownFieldsWarning`, `prisma_api.PrismaNewStructureWarning`
 
 ## v2 wrapper list
 
@@ -266,6 +267,24 @@ All methods below are available on `api.v2`.
 - `get_carbon_zeopp_experimental(mof=None, limit=500, offset=0)`
 - `get_carbon_zeopp_experimental_item(item_id)`
 
+### AutoPrism tables
+
+- `get_computation_runs(workflow_id=None, step=None, status=None, limit=500, offset=0)` / `get_computation_run(run_id)`
+- `upsert_computation_runs(payload, timeout=None, raise_on_error=False)`
+- `get_adsorption_singlepoint(...)` / `get_adsorption_singlepoint_item(row_id)` / `upsert_adsorption_singlepoint(payload, meta_provenance=None, repo_dir=None, timeout=None, raise_on_error=False, check_ids=True)`
+- `get_heat_capacity(...)` / `get_heat_capacity_item(row_id)` / `upsert_heat_capacity(payload, meta_provenance=None, repo_dir=None, timeout=None, raise_on_error=False, check_ids=True)`
+- `get_isotherm_h2(...)` / `get_isotherm_h2_item(row_id)` / `upsert_isotherm_h2(payload, meta_provenance=None, repo_dir=None, timeout=None, raise_on_error=False, check_ids=True)` — H2 only
+- `get_adsorption_isotherm(structure=None, isotherm_id=None, component=None, temperature_K=None, pressure_bar=None, limit=500, offset=0, md5=None)` / `get_adsorption_isotherm_item(row_id)` / `upsert_adsorption_isotherm(payload, meta_provenance=None, repo_dir=None, timeout=None, raise_on_error=False, check_ids=True)` — every gas except H2; needs prisma_cloud **>= 0.6.16** (older servers return 404)
+- `get_mofchecker(...)` / `get_mofchecker_item(row_id)` / `upsert_mofchecker(payload, meta_provenance=None, repo_dir=None, timeout=None, raise_on_error=False, check_ids=True)`
+- `get_zeopp_metrics(...)` / `get_zeopp_metrics_item(row_id)` / `upsert_zeopp_metrics(payload, meta_provenance=None, repo_dir=None, timeout=None, raise_on_error=False, check_ids=True)`
+- `get_autoprism_collection(...)` / `upsert_autoprism_collection(payload, meta_provenance=None, repo_dir=None, timeout=None, raise_on_error=False, check_ids=True)`
+
+Rejected rows (HTTP 207, or 400 when nothing is stored) raise
+`PrismaUpsertError` with `raise_on_error=True`, else emit
+`PrismaRowErrorWarning`. Ignored payload fields and newly created MOF records
+emit `PrismaUnknownFieldsWarning` / `PrismaNewStructureWarning`. See
+[API_REFERENCE_V2.md](API_REFERENCE_V2.md#autoprism-tables).
+
 ### TEA, LCA, cases, and scenarios
 
 - `get_output_kpis(scenario_id=None, mof=None, good_structure=None, limit=500, offset=0)`
@@ -373,7 +392,8 @@ pytest tests/ -v --cov=prisma_api --cov-report=term-missing
 
 ## Additional documentation
 
-- [API_REFERENCE.md](API_REFERENCE.md)
+- [API_REFERENCE_V1.md](API_REFERENCE_V1.md)
+- [API_REFERENCE_V2.md](API_REFERENCE_V2.md)
 - [DEVELOPMENT_SUMMARY.md](DEVELOPMENT_SUMMARY.md)
 - [User Guide.md](User%20Guide.md)
 
@@ -381,4 +401,5 @@ pytest tests/ -v --cov=prisma_api --cov-report=term-missing
 
 - Production v2 base URL: `https://prisma-platform.org/api/v2`
 - Authentication header: `X-API-Key`
-- Local development routing is controlled through config and `api.update_dev_mode(True)`
+- Local development routing is selected with `prisma_api.init(local_dev=True)`; the default targets production
+- 0.4.4: the `adsorption-isotherm` endpoints and the 400/notice handling need prisma_cloud >= 0.6.16

{prisma_api-0.4.2 → prisma_api-0.4.4}/README.md

@@ -161,6 +161,7 @@ Module-level helpers exported from the package:
 - `prisma_api.update_dev_mode`
 - `prisma_api.update_dev_host_port`
 - `prisma_api.locate_config`
+- `prisma_api.PrismaUpsertError`, `prisma_api.PrismaRowErrorWarning`, `prisma_api.PrismaUnknownFieldsWarning`, `prisma_api.PrismaNewStructureWarning`
 
 ## v2 wrapper list
 
@@ -246,6 +247,24 @@ All methods below are available on `api.v2`.
 - `get_carbon_zeopp_experimental(mof=None, limit=500, offset=0)`
 - `get_carbon_zeopp_experimental_item(item_id)`
 
+### AutoPrism tables
+
+- `get_computation_runs(workflow_id=None, step=None, status=None, limit=500, offset=0)` / `get_computation_run(run_id)`
+- `upsert_computation_runs(payload, timeout=None, raise_on_error=False)`
+- `get_adsorption_singlepoint(...)` / `get_adsorption_singlepoint_item(row_id)` / `upsert_adsorption_singlepoint(payload, meta_provenance=None, repo_dir=None, timeout=None, raise_on_error=False, check_ids=True)`
+- `get_heat_capacity(...)` / `get_heat_capacity_item(row_id)` / `upsert_heat_capacity(payload, meta_provenance=None, repo_dir=None, timeout=None, raise_on_error=False, check_ids=True)`
+- `get_isotherm_h2(...)` / `get_isotherm_h2_item(row_id)` / `upsert_isotherm_h2(payload, meta_provenance=None, repo_dir=None, timeout=None, raise_on_error=False, check_ids=True)` — H2 only
+- `get_adsorption_isotherm(structure=None, isotherm_id=None, component=None, temperature_K=None, pressure_bar=None, limit=500, offset=0, md5=None)` / `get_adsorption_isotherm_item(row_id)` / `upsert_adsorption_isotherm(payload, meta_provenance=None, repo_dir=None, timeout=None, raise_on_error=False, check_ids=True)` — every gas except H2; needs prisma_cloud **>= 0.6.16** (older servers return 404)
+- `get_mofchecker(...)` / `get_mofchecker_item(row_id)` / `upsert_mofchecker(payload, meta_provenance=None, repo_dir=None, timeout=None, raise_on_error=False, check_ids=True)`
+- `get_zeopp_metrics(...)` / `get_zeopp_metrics_item(row_id)` / `upsert_zeopp_metrics(payload, meta_provenance=None, repo_dir=None, timeout=None, raise_on_error=False, check_ids=True)`
+- `get_autoprism_collection(...)` / `upsert_autoprism_collection(payload, meta_provenance=None, repo_dir=None, timeout=None, raise_on_error=False, check_ids=True)`
+
+Rejected rows (HTTP 207, or 400 when nothing is stored) raise
+`PrismaUpsertError` with `raise_on_error=True`, else emit
+`PrismaRowErrorWarning`. Ignored payload fields and newly created MOF records
+emit `PrismaUnknownFieldsWarning` / `PrismaNewStructureWarning`. See
+[API_REFERENCE_V2.md](API_REFERENCE_V2.md#autoprism-tables).
+
 ### TEA, LCA, cases, and scenarios
 
 - `get_output_kpis(scenario_id=None, mof=None, good_structure=None, limit=500, offset=0)`
@@ -353,7 +372,8 @@ pytest tests/ -v --cov=prisma_api --cov-report=term-missing
 
 ## Additional documentation
 
-- [API_REFERENCE.md](API_REFERENCE.md)
+- [API_REFERENCE_V1.md](API_REFERENCE_V1.md)
+- [API_REFERENCE_V2.md](API_REFERENCE_V2.md)
 - [DEVELOPMENT_SUMMARY.md](DEVELOPMENT_SUMMARY.md)
 - [User Guide.md](User%20Guide.md)
 
@@ -361,4 +381,5 @@ pytest tests/ -v --cov=prisma_api --cov-report=term-missing
 
 - Production v2 base URL: `https://prisma-platform.org/api/v2`
 - Authentication header: `X-API-Key`
-- Local development routing is controlled through config and `api.update_dev_mode(True)`
+- Local development routing is selected with `prisma_api.init(local_dev=True)`; the default targets production
+- 0.4.4: the `adsorption-isotherm` endpoints and the 400/notice handling need prisma_cloud >= 0.6.16

prisma_api-0.4.4/prisma_api/__init__.py

@@ -0,0 +1,13 @@
+from importlib.metadata import PackageNotFoundError, version as _version
+
+try:
+    __version__ = _version("prisma_api")
+except PackageNotFoundError:  # running from a source tree without installing
+    __version__ = "0+unknown"
+
+
+from prisma_api.prisma_api import prisma_api as init        # Main prisma_api class for initialisation
+from prisma_api.prisma_api_v2 import PrismaAPIv2             # v2 API client (also accessible as api.v2)
+from prisma_api.prisma_api_v2 import (PrismaUpsertError, PrismaRowErrorWarning,  # upsert failure signals
+                                     PrismaUnknownFieldsWarning, PrismaNewStructureWarning)
+from prisma_api.config import update_dev_mode, update_dev_host_port, locate_config  # Config utility functions

{prisma_api-0.4.2 → prisma_api-0.4.4}/prisma_api/config.py

@@ -1,3 +1,5 @@
+import os
+import sys
 from pathlib import Path
 import pandas as pd
 import yaml
@@ -54,6 +56,12 @@ def create_config_file(api_key: str = None):
         raise ImportError("PyYAML is required. Install with: pip install pyyaml")
 
     if not api_key:
+        if not sys.stdin or not sys.stdin.isatty():
+            raise RuntimeError(
+                f"No PrISMa config file at {get_config_path()} and no API key in the "
+                f"environment. Set {', '.join(ENV_VARS)} (at least PRISMA_API_KEY), "
+                "or run interactively once to create the config file."
+            )
         val = input("Enter your PrISMa API key: ").strip()
         api_key = val
 
@@ -67,10 +75,40 @@ def create_config_file(api_key: str = None):
         yaml.safe_dump(cfg, f, sort_keys=False)
     return cfg
 
+# Environment variables read when no config file exists (or use_config_file=False)
+ENV_VARS = ("PRISMA_API_KEY", "PRISMA_API_DEV_API_KEY", "PRISMA_API_DEV_HOST_PORT")
+
+
+def config_from_env():
+    """
+    Build a config dict from PRISMA_API_* environment variables.
+
+    Returns None if none of them is set.
+    """
+    if not any(os.getenv(name) for name in ENV_VARS):
+        return None
+    prod_key = os.getenv("PRISMA_API_KEY", "")
+    return {
+        "api_key": prod_key,
+        "dev_api_key": os.getenv("PRISMA_API_DEV_API_KEY", prod_key),
+        "dev_host_port": os.getenv("PRISMA_API_DEV_HOST_PORT", "8000"),
+    }
+
+
 # Get or create config - intended use by initialisation of main prisma_api class
 def get_or_create_config():
-    """Return existing config or create it interactively if missing."""
+    """
+    Return the config, in order of preference:
+
+    1. config.yaml, if it exists;
+    2. PRISMA_API_* environment variables (nothing is written to disk);
+    3. an interactive prompt, which creates config.yaml. Without a terminal
+       (e.g. CI) this raises instead of blocking on input().
+    """
     cfg = load_config()
+    if cfg is not None:
+        return cfg
+    cfg = config_from_env()
     if cfg is not None:
         return cfg
     return create_config_file()

{prisma_api-0.4.2 → prisma_api-0.4.4}/prisma_api/prisma_api.py

@@ -25,11 +25,15 @@ def _safe_nan_check(x):
 # prisma_api main class
 class prisma_api():
 
-    def __init__(self, use_config_file=True, local_dev: bool = False):
+    def __init__(self, use_config_file=True, local_dev: bool = False,
+                 upload_timeout: int = 120):
         
         # Initialise `prisma_api` object with api_key location
         self.verbose = False
         # Initialise `prisma_api` object with api_key location
+        # use_config_file=True: config.yaml, else PRISMA_API_* env vars, else
+        # an interactive prompt (raises instead when there is no terminal).
+        # use_config_file=False: env vars only.
         if use_config_file:
             cfg = get_or_create_config()
             prod_key = cfg.get('api_key', '')
@@ -40,7 +44,9 @@ class prisma_api():
             dev_key = os.getenv('PRISMA_API_DEV_API_KEY', prod_key)
             dev_host_port = os.getenv('PRISMA_API_DEV_HOST_PORT', '8000')
 
-        # local_dev now controls target DB explicitly at init time.
+        # local_dev controls the target DB at init time:
+        #   local_dev=False (default) -> PRODUCTION (prisma-platform.org)
+        #   local_dev=True            -> local dev server on localhost:<dev_host_port>
         self.dev = bool(local_dev)
         self.dev_host_port = dev_host_port
         self.key = dev_key if self.dev else prod_key
@@ -50,8 +56,13 @@ class prisma_api():
             dev=self.dev,
             dev_host_port=getattr(self, 'dev_host_port', ''),
             return_format=getattr(self, '_return_format', 'json'),
+            upload_timeout=upload_timeout,
         )
 
+        # Make the target explicit so test uploads don't go to production by mistake.
+        target = "LOCAL DEV" if self.dev else "PRODUCTION"
+        print(f"prisma_api: connected to {target} API at {self.v2._base_url()}")
+
     def set_return_format(self, fmt: str) -> None:
         """
         Set the output format for all v2 list endpoints.