prisma-api 0.3.1__tar.gz → 0.3.3__tar.gz

{prisma_api-0.3.1 → prisma_api-0.3.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: prisma_api
-Version: 0.3.1
+Version: 0.3.3
 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
@@ -27,7 +27,6 @@ This package provides:
 - legacy v1 wrappers on the main `api` object
 - a larger v2 REST client on `api.v2`
 - local config-based API-key management
-- optional local development routing via `api.update_dev_mode(True)`
 
 PrISMa is a platform for numerical synthesis and assessment of metal-organic frameworks and related carbon-capture workflows.
 
@@ -39,22 +38,6 @@ PrISMa is a platform for numerical synthesis and assessment of metal-organic fra
 pip install prisma_api
 ```
 
-### From source
-
-```bash
-git clone https://github.com/RCCS-CaptureTeam/prisma_api.git
-cd prisma_api
-pip install .
-```
-
-### Development install
-
-```bash
-git clone https://github.com/RCCS-CaptureTeam/prisma_api.git
-cd prisma_api
-pip install -e ".[dev]"
-```
-
 ### Requirements
 
 - Python 3.10+
@@ -74,6 +57,12 @@ api = prisma_api.init()
 
 On first use, the package creates a config file and prompts for an API key.
 
+### Upgrades
+
+```python
+pip install --upgrade prisma_api
+```
+
 ### Find the config path
 
 ```python
@@ -127,24 +116,16 @@ materials_df = api.v2.list_materials(name="ABEX")
 print(materials_df.head())
 ```
 
-### Dev mode
+### Flowsheets
 
 ```python
 import prisma_api
 
-api = prisma_api.init()
-api.update_dev_mode(True)
 api = prisma_api.init()
 
 flowsheet = api.v2.get_flowsheet(name="dac_min")
 ```
 
-Disable dev mode the same way:
-
-```python
-api.update_dev_mode(False)
-api = prisma_api.init()
-```
 
 ## Return formats
 

{prisma_api-0.3.1 → prisma_api-0.3.3}/README.md

@@ -7,7 +7,6 @@ This package provides:
 - legacy v1 wrappers on the main `api` object
 - a larger v2 REST client on `api.v2`
 - local config-based API-key management
-- optional local development routing via `api.update_dev_mode(True)`
 
 PrISMa is a platform for numerical synthesis and assessment of metal-organic frameworks and related carbon-capture workflows.
 
@@ -19,22 +18,6 @@ PrISMa is a platform for numerical synthesis and assessment of metal-organic fra
 pip install prisma_api
 ```
 
-### From source
-
-```bash
-git clone https://github.com/RCCS-CaptureTeam/prisma_api.git
-cd prisma_api
-pip install .
-```
-
-### Development install
-
-```bash
-git clone https://github.com/RCCS-CaptureTeam/prisma_api.git
-cd prisma_api
-pip install -e ".[dev]"
-```
-
 ### Requirements
 
 - Python 3.10+
@@ -54,6 +37,12 @@ api = prisma_api.init()
 
 On first use, the package creates a config file and prompts for an API key.
 
+### Upgrades
+
+```python
+pip install --upgrade prisma_api
+```
+
 ### Find the config path
 
 ```python
@@ -107,24 +96,16 @@ materials_df = api.v2.list_materials(name="ABEX")
 print(materials_df.head())
 ```
 
-### Dev mode
+### Flowsheets
 
 ```python
 import prisma_api
 
-api = prisma_api.init()
-api.update_dev_mode(True)
 api = prisma_api.init()
 
 flowsheet = api.v2.get_flowsheet(name="dac_min")
 ```
 
-Disable dev mode the same way:
-
-```python
-api.update_dev_mode(False)
-api = prisma_api.init()
-```
 
 ## Return formats
 

{prisma_api-0.3.1 → prisma_api-0.3.3}/prisma_api/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.3.1"
+__version__ = "0.3.3"
 
 
 from prisma_api.prisma_api import prisma_api as init        # Main prisma_api class for initialisation

{prisma_api-0.3.1 → prisma_api-0.3.3}/prisma_api/prisma_api_v2.py

@@ -132,6 +132,14 @@ class PrismaAPIv2:
         """
         return self._get(f"/flowsheets/{name}/")
 
+    def get_flowsheet_bundle(self) -> dict:
+        """
+        GET /api/v2/flowsheets/dac_min/bundle/
+
+        Returns the bundled flowsheet payload for the dac_min object.
+        """
+        return self._get("/flowsheets/dac_min/bundle/")
+
     # ── Catalog ───────────────────────────────────────────────────────────────
 
     def list_materials(self, name: str | None = None,

{prisma_api-0.3.1 → prisma_api-0.3.3}/prisma_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: prisma_api
-Version: 0.3.1
+Version: 0.3.3
 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
@@ -27,7 +27,6 @@ This package provides:
 - legacy v1 wrappers on the main `api` object
 - a larger v2 REST client on `api.v2`
 - local config-based API-key management
-- optional local development routing via `api.update_dev_mode(True)`
 
 PrISMa is a platform for numerical synthesis and assessment of metal-organic frameworks and related carbon-capture workflows.
 
@@ -39,22 +38,6 @@ PrISMa is a platform for numerical synthesis and assessment of metal-organic fra
 pip install prisma_api
 ```
 
-### From source
-
-```bash
-git clone https://github.com/RCCS-CaptureTeam/prisma_api.git
-cd prisma_api
-pip install .
-```
-
-### Development install
-
-```bash
-git clone https://github.com/RCCS-CaptureTeam/prisma_api.git
-cd prisma_api
-pip install -e ".[dev]"
-```
-
 ### Requirements
 
 - Python 3.10+
@@ -74,6 +57,12 @@ api = prisma_api.init()
 
 On first use, the package creates a config file and prompts for an API key.
 
+### Upgrades
+
+```python
+pip install --upgrade prisma_api
+```
+
 ### Find the config path
 
 ```python
@@ -127,24 +116,16 @@ materials_df = api.v2.list_materials(name="ABEX")
 print(materials_df.head())
 ```
 
-### Dev mode
+### Flowsheets
 
 ```python
 import prisma_api
 
-api = prisma_api.init()
-api.update_dev_mode(True)
 api = prisma_api.init()
 
 flowsheet = api.v2.get_flowsheet(name="dac_min")
 ```
 
-Disable dev mode the same way:
-
-```python
-api.update_dev_mode(False)
-api = prisma_api.init()
-```
 
 ## Return formats
 

{prisma_api-0.3.1 → prisma_api-0.3.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "prisma_api"
-version = "0.3.1"
+version = "0.3.3"
 description = "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."
 authors = [
     {name = "RCCS-CaptureTeam", email = "team@prisma-platform.org"}

{prisma_api-0.3.1 → prisma_api-0.3.3}/tests/test_prisma_api_v2.py

@@ -1440,3 +1440,20 @@ def test_get_flowsheet_uses_dev_mode_base_url(dev_api):
                  json={"template_id": "dac_min"}, status=200)
     result = dev_api.get_flowsheet(name="dac_min")
     assert result["template_id"] == "dac_min"
+
+
+@resp_lib.activate
+def test_get_flowsheet_bundle_returns_dict(api):
+    expected = {"template_id": "dac_min", "bundle": {"nodes": [], "edges": []}}
+    resp_lib.add(resp_lib.GET, f"{PROD_BASE}/flowsheets/dac_min/bundle/",
+                 json=expected, status=200)
+    result = api.get_flowsheet_bundle()
+    assert result == expected
+
+
+@resp_lib.activate
+def test_get_flowsheet_bundle_uses_dev_mode_base_url(dev_api):
+    resp_lib.add(resp_lib.GET, f"{dev_api._base_url()}/flowsheets/dac_min/bundle/",
+                 json={"template_id": "dac_min"}, status=200)
+    result = dev_api.get_flowsheet_bundle()
+    assert result["template_id"] == "dac_min"