plexosdb 1.4.1__tar.gz → 1.6.0__tar.gz

{plexosdb-1.4.1 → plexosdb-1.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: plexosdb
-Version: 1.4.1
+Version: 1.6.0
 Summary: SQLite API for plexos XMLs
 Keywords: PLEXOS,Database,SQLite
 Author: Pedro Andres Sanchez Perez, Kodi Obika, mcllerena
@@ -33,6 +33,8 @@ Classifier: Topic :: Software Development :: Build Tools
 Classifier: Topic :: Database
 Classifier: Typing :: Typed
 Requires-Dist: loguru
+Requires-Dist: plexos2duckdb>=0.1.0b11
+Requires-Dist: pre-commit>=4.6.0
 Maintainer: Pedro Andres Sanchez Perez, Kodi Obika, mcllerena
 Maintainer-email: Pedro Andres Sanchez Perez <psanchez@nrel.gov>, Kodi Obika <kodi.obika@nrel.gov>, mcllerena <mcllerena@users.noreply.github.com>
 Requires-Python: >=3.11, <3.15
@@ -100,11 +102,56 @@ db.add_membership(
 db.to_xml("modified_model.xml")
 ```
 
+## Versioned Schema Initialization
+
+When creating a brand-new database (not importing XML), you can preload the
+matching PLEXOS master template by version:
+
+```python
+from plexosdb import PlexosDB
+
+db = PlexosDB()
+db.create_schema(version=10)
+```
+
+Supported versions: 9, 10, 11, 12.
+
+Accepted inputs include integers, strings, and tuples. For example:
+
+```python
+db.create_schema(version="v11.0R4")
+db.create_schema(version=(12, 0, 3))
+```
+
+## Read PLEXOS Solution ZIP Tables with pandas
+
+```python
+from plexosdb import PlexosSolution
+import pandas as pd
+
+PLEXOS_SOLUTION = "/path/to/solution.zip"
+
+sol = PlexosSolution.from_zip(PLEXOS_SOLUTION)
+sol.to_sqlite("output.sqlite", if_exists="replace")
+
+table = "ST__Interval__Regions__Fixed_Load"
+sol.materialize_table(table, schema="report")
+df_table = pd.read_sql_query(f'SELECT * FROM report."{table}"', sol.connection)
+```
+
+This pattern is useful when you only need a few report/data tables from a large
+solution ZIP, because it materializes tables on demand.
+
 ## Documentation
 
 Full documentation is available at
 [natlabrockies.github.io/plexosdb](https://natlabrockies.github.io/plexosdb/).
 
+## Related Work
+
+For related previous/current work on querying PLEXOS outputs with DuckDB, see
+[plexos2duckdb](https://github.com/NatLabRockies/plexos2duckdb).
+
 ## Developer Setup
 
 plexosdb uses [uv](https://docs.astral.sh/uv/) for dependency management.

{plexosdb-1.4.1 → plexosdb-1.6.0}/README.md

@@ -56,11 +56,56 @@ db.add_membership(
 db.to_xml("modified_model.xml")
 ```
 
+## Versioned Schema Initialization
+
+When creating a brand-new database (not importing XML), you can preload the
+matching PLEXOS master template by version:
+
+```python
+from plexosdb import PlexosDB
+
+db = PlexosDB()
+db.create_schema(version=10)
+```
+
+Supported versions: 9, 10, 11, 12.
+
+Accepted inputs include integers, strings, and tuples. For example:
+
+```python
+db.create_schema(version="v11.0R4")
+db.create_schema(version=(12, 0, 3))
+```
+
+## Read PLEXOS Solution ZIP Tables with pandas
+
+```python
+from plexosdb import PlexosSolution
+import pandas as pd
+
+PLEXOS_SOLUTION = "/path/to/solution.zip"
+
+sol = PlexosSolution.from_zip(PLEXOS_SOLUTION)
+sol.to_sqlite("output.sqlite", if_exists="replace")
+
+table = "ST__Interval__Regions__Fixed_Load"
+sol.materialize_table(table, schema="report")
+df_table = pd.read_sql_query(f'SELECT * FROM report."{table}"', sol.connection)
+```
+
+This pattern is useful when you only need a few report/data tables from a large
+solution ZIP, because it materializes tables on demand.
+
 ## Documentation
 
 Full documentation is available at
 [natlabrockies.github.io/plexosdb](https://natlabrockies.github.io/plexosdb/).
 
+## Related Work
+
+For related previous/current work on querying PLEXOS outputs with DuckDB, see
+[plexos2duckdb](https://github.com/NatLabRockies/plexos2duckdb).
+
 ## Developer Setup
 
 plexosdb uses [uv](https://docs.astral.sh/uv/) for dependency management.

{plexosdb-1.4.1 → plexosdb-1.6.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "plexosdb"
-version = "1.4.1"
+version = "1.6.0"
 readme = "README.md"
 license = {file = "LICENSE.txt"}
 keywords = ["PLEXOS", "Database", "SQLite"]
@@ -35,6 +35,8 @@ classifiers = [
 ]
 dependencies = [
     "loguru",
+    "plexos2duckdb>=0.1.0b11",
+    "pre-commit>=4.6.0",
 ]
 
 [project.urls]
@@ -71,15 +73,6 @@ dev = [
     "ruff>=0.11.5",
 ]
 
-[tool.setuptools]
-include-package-data = true
-
-[tool.setuptools.package-data]
-"*" = ["*.json", "*.csv", "*.xml", ".sql"]
-
-[tool.setuptools.packages.find]
-where = ["src"]
-
 [tool.ty.src]
 include = ["src/plexosdb"]
 exclude = ["tests/"]

plexosdb-1.6.0/src/plexosdb/__init__.py

@@ -0,0 +1,43 @@
+"""Entrypoint for the PlexosDB client providing its exports."""
+
+from importlib.metadata import version
+
+from loguru import logger
+
+from .db import PlexosDB, PropertyRecord
+from .db_manager import SQLiteManager
+from .db_solution import PlexosSolution
+from .db_solution_models import (
+    DuckDBResult,
+    DuckDBSchema,
+    DuckDBSolutionInfo,
+    IfExists,
+    ResultSchema,
+    ResultTable,
+    TableInfo,
+)
+from .enums import ClassEnum, CollectionEnum, PeriodEnum, PhaseEnum, TableTypeEnum
+from .xml_handler import XMLHandler
+
+__version__ = version("plexosdb")
+
+logger.disable("r2x_core")
+
+__all__ = (
+    "ClassEnum",
+    "CollectionEnum",
+    "DuckDBResult",
+    "DuckDBSchema",
+    "DuckDBSolutionInfo",
+    "IfExists",
+    "PeriodEnum",
+    "PhaseEnum",
+    "PlexosDB",
+    "PlexosSolution",
+    "PropertyRecord",
+    "ResultSchema",
+    "ResultTable",
+    "TableInfo",
+    "TableTypeEnum",
+    "XMLHandler",
+)

{plexosdb-1.4.1 → plexosdb-1.6.0}/src/plexosdb/checks.py

@@ -60,13 +60,21 @@ def check_attribute_exists(
     Returns
     -------
     bool
-        True if the attribute exists for the object.
-
-    Notes
-    -----
-    This check is not yet implemented.
+        True if the object has an assigned value for the attribute.
+    """
+    query = """
+        SELECT 1
+        FROM t_attribute_data AS data
+        JOIN t_object AS obj ON obj.object_id = data.object_id
+        JOIN t_attribute AS attr ON attr.attribute_id = data.attribute_id
+        JOIN t_class AS class ON class.class_id = obj.class_id
+        WHERE obj.name = ?
+        AND class.name = ?
+        AND attr.name = ?
+        AND attr.class_id = obj.class_id
+        LIMIT 1
     """
-    raise NotImplementedError
+    return bool(db._db.query(query, (object_name, object_class, attribute_name)))
 
 
 def check_class_exists(db: PlexosDB, class_enum: ClassEnum) -> bool: