tracdap-runtime 0.9.1__tar.gz → 0.9.2.dev4__tar.gz

tracdap_runtime-0.9.2.dev4/PKG-INFO

@@ -0,0 +1,268 @@
+Metadata-Version: 2.4
+Name: tracdap-runtime
+Version: 0.9.2.dev4
+Summary: Portable, production-grade models in Python
+Home-page: https://www.fintrac.co.uk/
+Author: Martin Traverse
+Author-email: martin@fintrac.co.uk
+License: Apache-2.0
+Project-URL: Documentation, https://docs.fintrac.co.uk/versions/latest/modelling
+Project-URL: Source Code, https://github.com/martin-traverse/tracdap
+Project-URL: Issue Tracker, https://github.com/martin-traverse/tracdap/issues
+Platform: any
+Classifier: Operating System :: OS Independent
+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: Intended Audience :: Developers
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: Topic :: Office/Business
+Classifier: Topic :: Office/Business :: Financial
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: protobuf==6.31.1
+Requires-Dist: pyarrow==21.0.0
+Requires-Dist: pyyaml==6.0.2
+Requires-Dist: dulwich==0.23.2
+Requires-Dist: requests==2.32.4
+Provides-Extra: grpc
+Requires-Dist: grpcio==1.74.0; extra == "grpc"
+Requires-Dist: grpcio-status==1.74.0; extra == "grpc"
+Provides-Extra: pandas
+Requires-Dist: pandas<2.3.0,>=1.2.0; extra == "pandas"
+Requires-Dist: numpy<2.3.0,>=1.20; extra == "pandas"
+Provides-Extra: polars
+Requires-Dist: polars<2.0.0,>=1.0.0; extra == "polars"
+Provides-Extra: pyspark
+Requires-Dist: pyspark<3.6.0,>=3.0.0; extra == "pyspark"
+Provides-Extra: sql
+Requires-Dist: sqlalchemy<2.1.0,>=2.0.0; extra == "sql"
+Provides-Extra: aws
+Requires-Dist: botocore==1.39.15; extra == "aws"
+Requires-Dist: boto3==1.39.15; extra == "aws"
+Provides-Extra: gcp
+Requires-Dist: google-auth==2.40.3; extra == "gcp"
+Requires-Dist: google-api-core==2.25.1; extra == "gcp"
+Requires-Dist: google-cloud-storage==3.2.0; extra == "gcp"
+Requires-Dist: gcsfs==2024.3.1; extra == "gcp"
+Provides-Extra: azure
+Requires-Dist: azure-core==1.35.0; extra == "azure"
+Requires-Dist: azure-identity==1.23.1; extra == "azure"
+Requires-Dist: azure-storage-blob==12.26.0; extra == "azure"
+Requires-Dist: adlfs==2024.12.0; extra == "azure"
+Dynamic: license-file
+
+<div align="center">
+
+![TRAC the modern model platform](https://github.com/finos/tracdap/raw/main/doc/_images/tracmmp_horizontal_400.png)
+
+  <br />
+
+  <div>
+    <a href="https://pypi.org/project/tracdap-runtime"><img alt="PyPI Version" src="https://img.shields.io/pypi/v/tracdap-runtime.svg?maxAge=3600" /></a>
+    <a href="https://pypi.org/project/tracdap-runtime"><img alt="Python Versions" src="https://img.shields.io/pypi/pyversions/tracdap-runtime.svg?maxAge=3600" /></a>
+    <a href="https://github.com/finos/tracdap/actions/workflows/packaging.yaml?query=branch%3Amain"><img alt="Packaging status" src="https://github.com/finos/tracdap/actions/workflows/packaging.yaml/badge.svg?branch:main&workflow:CI" /></a>
+    <a href="https://github.com/finos/tracdap/actions/workflows/compliance.yaml?query=branch%3Amain"><img alt="Compliance status" src="https://github.com/finos/tracdap/actions/workflows/compliance.yaml/badge.svg?branch:main&workflow:CI" /></a>
+    <a href="https://github.com/pandas-dev/pandas/blob/main/LICENSE"><img alt="License - Apache-2.0" src="https://img.shields.io/pypi/l/tracdap-runtime.svg" /></a>
+    <a href="https://community.finos.org/docs/governance/software-projects/stages/incubating/"><img alt="FINOS - Incubating" src="https://cdn.jsdelivr.net/gh/finos/contrib-toolbox@master/images/badge-incubating.svg" /></a>
+  </div>
+
+  <p>
+    <a href="https://www.fintrac.co.uk/">Homepage</a>
+    ◆ <a href="https://docs.fintrac.co.uk/versions/latest/modelling">Documentation</a>
+    ◆ <a href="https://github.com/fintrac-hub/examples">Examples</a>
+    ◆ <a href="https://github.com/finos/tracdap">Source Code</a>
+    ◆ <a href="https://github.com/finos/tracdap/issues">Issue Tracker</a>
+  </p>
+</div>
+
+
+# TRAC Model Runtime for Python
+
+The TRAC Model Runtime is a lightweight package for building portable,
+production-grade Python models. Models created with the runtime can be
+executed anywhere, from local development environments to enterprise
+production systems. The runtime can be used independently of the broader
+TRAC platform and provides a simple framework in which to build, ship,
+and share models.
+
+Each model defines its parameters, inputs and outputs, and the runtime
+provides the execution context, ensuring that models always receive valid
+data and parameters. Taking responsibility for data access, marshalling
+and formatting out of the model code allows developers to focus on model
+logic, safe in the knowledge that the model will behave consistently
+across environments.
+
+For a complete guide to writing models in the TRAC framework, see the
+[online documentation](https://docs.fintrac.co.uk/versions/latest/modelling).
+
+
+## 📦 Requirements
+
+* **Python :**  3.10 or later
+* **Tools :**   Any popular IDE (PyCharm, VS Code, etc.)
+* **Pandas :**  Version 1.2 and later are supported
+* **Polars :**  Version 1.0 and later are supported
+
+*Some 3rd party libraries may have additional version constraints,
+for example, Pandas 1.5 is not available for Python 3.12 or later.*
+
+
+## 🚀 Quick start
+
+TRAC can be added to a new or existing Python project using [pip](https://pip.pypa.io):
+
+```shell
+$ pip install tracdap-runtime
+```
+
+You will also need to install a data framework (Pandas or Polars) and any other libraries that the model uses.
+
+Here is a minimum working example of a TRAC model that performs aggregation on a dataset:
+
+```python
+import tracdap.rt.api as trac
+
+class QuickStartModel(trac.TracModel):
+
+    def define_parameters(self):
+        
+        # Define any parameters the model will use
+        return trac.define_parameters(
+            trac.P("exchange_rate", trac.FLOAT, "EUR / GBP exchange rate")
+        )
+
+    def define_inputs(self):
+        
+        # Define an input table with the columns and data types that the model needs
+        customer_loans = trac.define_input_table(
+            trac.F("id", trac.STRING, label="Customer account ID", business_key=True),
+            trac.F("region", trac.STRING, label="Customer home region", categorical=True),
+            trac.F("loan_amount", trac.FLOAT, label="Principal loan amount"),
+            label="Customer loans data")
+
+        return {"customer_loans": customer_loans}
+
+    def define_outputs(self):
+        
+        # Define an output table with the columns and data types that the model will produce
+        loans_by_region = trac.define_output_table(
+            trac.F("region", trac.STRING, label="Customer home region", categorical=True),
+            trac.F("loan_amount", trac.FLOAT, label="Principal loan amount"),
+            label="Loans by region")
+
+        return {"loans_by_region": loans_by_region}
+
+    def run_model(self, ctx: trac.TracContext):
+        
+        # Parameters and inputs are loaded and validated by TRAC
+        exchange_rate = ctx.get_parameter("exchange_rate")
+        customer_loans = ctx.get_pandas_table("customer_loans")
+
+        # Model code is regular Python
+        customer_loans["loan_amount_gbp"] = customer_loans["loan_amount"] * exchange_rate
+
+        loans_by_region = customer_loans \
+            .groupby("region", as_index=False) \
+            .aggregate({"loan_amount": "sum"})
+
+        # Logs written to ctx.log are captured by the platform
+        ctx.log().info("Aggregated loans for {} regions", len(loans_by_region))
+
+        # Outputs are handed back to TRAC for validation and saving
+        ctx.put_pandas_table("loans_by_region", loans_by_region)
+
+# Use the desktop launcher to run, test and debug models locally
+if __name__ == "__main__":
+    import tracdap.rt.launch as launch
+    launch.launch_model(QuickStartModel, "config/quick_start.yaml", "config/sys_config.yaml")
+```
+
+The model needs two config files in order to run: A job config file and a system config file.
+By convention, for local development these are kept in a ``config`` folder.
+
+The system config file defines the resources that are available for models to use.
+As a minimum the default storage location must be specified.
+
+*sys_config.yaml*
+```yaml
+properties:
+
+  storage.default.location: example_data
+  storage.default.format: CSV
+
+resources:
+
+  example_data:
+    resourceType: INTERNAL_STORAGE
+    protocol: LOCAL
+    properties:
+      rootPath: C:\path\to\your\data
+```
+
+The job config file supplies the model with the parameters, inputs and outputs that it needs to run.
+The default data location from ``sys_config.yaml`` is used to load input data and save output data.
+TRAC checks the types and schemas of every parameter and input dataset, types are cast automatically
+where it is safe to do so, otherwise TRAC will raise an error if the inputs are not valid.
+
+*quick_start.yaml*
+```yaml
+job:
+  runModel:
+    
+    parameters:
+      exchange_rate: 0.865
+    
+    inputs:
+      customer_loans: "inputs/customer_loans_data.csv"
+
+    outputs:
+      loans_by_region: "outputs/example_model/loans_by_region.csv"
+```
+
+You can run the model from your IDE (right click the model file and choose "Run",
+or look for the "Play" button). You will see the model logs, and an output file
+will be created inside your data folder.
+
+
+## 📖 Documentation
+
+See the [online documentation](https://docs.fintrac.co.uk/versions/latest/modelling)
+for a complete guide to writing models in the TRAC framework,
+including tutorials and an API reference.
+
+
+## ✋ Contributing
+
+If you'd like to contribute a feature or a fix then we'd love to hear from you!
+Please raise an issue on our [issue tracker](https://github.com/finos/tracdap/issues)
+to discuss your suggestion before working on a PR.
+
+Contributions are governed according to the [contribution guidelines](https://github.com/finos/tracdap/blob/main/CONTRIBUTING.md)
+and the [FINOS code of conduct](https://www.finos.org/code-of-conduct).
+
+
+## 📜 License
+
+The TRAC model runtime is maintained by [finTRAC Ltd](https://fintrac.co.uk/) in association with
+the [Fintech Open Source Foundation](https://www.finos.org/) (FINOS) and distributed under the terms of
+the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
+
+SPDX-License-Identifier: [Apache-2.0](https://spdx.org/licenses/Apache-2.0)
+
+For more information including copyright history,
+see the [NOTICE](https://github.com/finos/tracdap/blob/main/NOTICE) file.
+
+
+## 🏢 Enterprise
+
+Professional support for TRAC is available from [finTRAC Ltd](https://fintrac.co.uk/),
+for more information please [contact us](https://fintrac.co.uk/contact).

tracdap_runtime-0.9.2.dev4/README.md

@@ -0,0 +1,206 @@
+<div align="center">
+
+![TRAC the modern model platform](https://github.com/finos/tracdap/raw/main/doc/_images/tracmmp_horizontal_400.png)
+
+  <br />
+
+  <div>
+    <a href="https://pypi.org/project/tracdap-runtime"><img alt="PyPI Version" src="https://img.shields.io/pypi/v/tracdap-runtime.svg?maxAge=3600" /></a>
+    <a href="https://pypi.org/project/tracdap-runtime"><img alt="Python Versions" src="https://img.shields.io/pypi/pyversions/tracdap-runtime.svg?maxAge=3600" /></a>
+    <a href="https://github.com/finos/tracdap/actions/workflows/packaging.yaml?query=branch%3Amain"><img alt="Packaging status" src="https://github.com/finos/tracdap/actions/workflows/packaging.yaml/badge.svg?branch:main&workflow:CI" /></a>
+    <a href="https://github.com/finos/tracdap/actions/workflows/compliance.yaml?query=branch%3Amain"><img alt="Compliance status" src="https://github.com/finos/tracdap/actions/workflows/compliance.yaml/badge.svg?branch:main&workflow:CI" /></a>
+    <a href="https://github.com/pandas-dev/pandas/blob/main/LICENSE"><img alt="License - Apache-2.0" src="https://img.shields.io/pypi/l/tracdap-runtime.svg" /></a>
+    <a href="https://community.finos.org/docs/governance/software-projects/stages/incubating/"><img alt="FINOS - Incubating" src="https://cdn.jsdelivr.net/gh/finos/contrib-toolbox@master/images/badge-incubating.svg" /></a>
+  </div>
+
+  <p>
+    <a href="https://www.fintrac.co.uk/">Homepage</a>
+    ◆ <a href="https://docs.fintrac.co.uk/versions/latest/modelling">Documentation</a>
+    ◆ <a href="https://github.com/fintrac-hub/examples">Examples</a>
+    ◆ <a href="https://github.com/finos/tracdap">Source Code</a>
+    ◆ <a href="https://github.com/finos/tracdap/issues">Issue Tracker</a>
+  </p>
+</div>
+
+
+# TRAC Model Runtime for Python
+
+The TRAC Model Runtime is a lightweight package for building portable,
+production-grade Python models. Models created with the runtime can be
+executed anywhere, from local development environments to enterprise
+production systems. The runtime can be used independently of the broader
+TRAC platform and provides a simple framework in which to build, ship,
+and share models.
+
+Each model defines its parameters, inputs and outputs, and the runtime
+provides the execution context, ensuring that models always receive valid
+data and parameters. Taking responsibility for data access, marshalling
+and formatting out of the model code allows developers to focus on model
+logic, safe in the knowledge that the model will behave consistently
+across environments.
+
+For a complete guide to writing models in the TRAC framework, see the
+[online documentation](https://docs.fintrac.co.uk/versions/latest/modelling).
+
+
+## 📦 Requirements
+
+* **Python :**  3.10 or later
+* **Tools :**   Any popular IDE (PyCharm, VS Code, etc.)
+* **Pandas :**  Version 1.2 and later are supported
+* **Polars :**  Version 1.0 and later are supported
+
+*Some 3rd party libraries may have additional version constraints,
+for example, Pandas 1.5 is not available for Python 3.12 or later.*
+
+
+## 🚀 Quick start
+
+TRAC can be added to a new or existing Python project using [pip](https://pip.pypa.io):
+
+```shell
+$ pip install tracdap-runtime
+```
+
+You will also need to install a data framework (Pandas or Polars) and any other libraries that the model uses.
+
+Here is a minimum working example of a TRAC model that performs aggregation on a dataset:
+
+```python
+import tracdap.rt.api as trac
+
+class QuickStartModel(trac.TracModel):
+
+    def define_parameters(self):
+        
+        # Define any parameters the model will use
+        return trac.define_parameters(
+            trac.P("exchange_rate", trac.FLOAT, "EUR / GBP exchange rate")
+        )
+
+    def define_inputs(self):
+        
+        # Define an input table with the columns and data types that the model needs
+        customer_loans = trac.define_input_table(
+            trac.F("id", trac.STRING, label="Customer account ID", business_key=True),
+            trac.F("region", trac.STRING, label="Customer home region", categorical=True),
+            trac.F("loan_amount", trac.FLOAT, label="Principal loan amount"),
+            label="Customer loans data")
+
+        return {"customer_loans": customer_loans}
+
+    def define_outputs(self):
+        
+        # Define an output table with the columns and data types that the model will produce
+        loans_by_region = trac.define_output_table(
+            trac.F("region", trac.STRING, label="Customer home region", categorical=True),
+            trac.F("loan_amount", trac.FLOAT, label="Principal loan amount"),
+            label="Loans by region")
+
+        return {"loans_by_region": loans_by_region}
+
+    def run_model(self, ctx: trac.TracContext):
+        
+        # Parameters and inputs are loaded and validated by TRAC
+        exchange_rate = ctx.get_parameter("exchange_rate")
+        customer_loans = ctx.get_pandas_table("customer_loans")
+
+        # Model code is regular Python
+        customer_loans["loan_amount_gbp"] = customer_loans["loan_amount"] * exchange_rate
+
+        loans_by_region = customer_loans \
+            .groupby("region", as_index=False) \
+            .aggregate({"loan_amount": "sum"})
+
+        # Logs written to ctx.log are captured by the platform
+        ctx.log().info("Aggregated loans for {} regions", len(loans_by_region))
+
+        # Outputs are handed back to TRAC for validation and saving
+        ctx.put_pandas_table("loans_by_region", loans_by_region)
+
+# Use the desktop launcher to run, test and debug models locally
+if __name__ == "__main__":
+    import tracdap.rt.launch as launch
+    launch.launch_model(QuickStartModel, "config/quick_start.yaml", "config/sys_config.yaml")
+```
+
+The model needs two config files in order to run: A job config file and a system config file.
+By convention, for local development these are kept in a ``config`` folder.
+
+The system config file defines the resources that are available for models to use.
+As a minimum the default storage location must be specified.
+
+*sys_config.yaml*
+```yaml
+properties:
+
+  storage.default.location: example_data
+  storage.default.format: CSV
+
+resources:
+
+  example_data:
+    resourceType: INTERNAL_STORAGE
+    protocol: LOCAL
+    properties:
+      rootPath: C:\path\to\your\data
+```
+
+The job config file supplies the model with the parameters, inputs and outputs that it needs to run.
+The default data location from ``sys_config.yaml`` is used to load input data and save output data.
+TRAC checks the types and schemas of every parameter and input dataset, types are cast automatically
+where it is safe to do so, otherwise TRAC will raise an error if the inputs are not valid.
+
+*quick_start.yaml*
+```yaml
+job:
+  runModel:
+    
+    parameters:
+      exchange_rate: 0.865
+    
+    inputs:
+      customer_loans: "inputs/customer_loans_data.csv"
+
+    outputs:
+      loans_by_region: "outputs/example_model/loans_by_region.csv"
+```
+
+You can run the model from your IDE (right click the model file and choose "Run",
+or look for the "Play" button). You will see the model logs, and an output file
+will be created inside your data folder.
+
+
+## 📖 Documentation
+
+See the [online documentation](https://docs.fintrac.co.uk/versions/latest/modelling)
+for a complete guide to writing models in the TRAC framework,
+including tutorials and an API reference.
+
+
+## ✋ Contributing
+
+If you'd like to contribute a feature or a fix then we'd love to hear from you!
+Please raise an issue on our [issue tracker](https://github.com/finos/tracdap/issues)
+to discuss your suggestion before working on a PR.
+
+Contributions are governed according to the [contribution guidelines](https://github.com/finos/tracdap/blob/main/CONTRIBUTING.md)
+and the [FINOS code of conduct](https://www.finos.org/code-of-conduct).
+
+
+## 📜 License
+
+The TRAC model runtime is maintained by [finTRAC Ltd](https://fintrac.co.uk/) in association with
+the [Fintech Open Source Foundation](https://www.finos.org/) (FINOS) and distributed under the terms of
+the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
+
+SPDX-License-Identifier: [Apache-2.0](https://spdx.org/licenses/Apache-2.0)
+
+For more information including copyright history,
+see the [NOTICE](https://github.com/finos/tracdap/blob/main/NOTICE) file.
+
+
+## 🏢 Enterprise
+
+Professional support for TRAC is available from [finTRAC Ltd](https://fintrac.co.uk/),
+for more information please [contact us](https://fintrac.co.uk/contact).

{tracdap_runtime-0.9.1 → tracdap_runtime-0.9.2.dev4}/setup.cfg

@@ -1,19 +1,32 @@
 [metadata]
 name = tracdap-runtime
-version = 0.9.1
+version = 0.9.2.dev4
 license = Apache-2.0
 platform = any
-description = Runtime package for building models on the TRAC Data & Analytics Platform
+description = Portable, production-grade models in Python
 long_description = file: README.md
 long_description_content_type = text/markdown
-url = https://tracdap.finos.org/
+url = https://www.fintrac.co.uk/
 project_urls = 
-	Documentation = https://tracdap.readthedocs.io/
-	Source Code = https://github.com/finos/tracdap
-	Bug Tracker = https://github.com/finos/tracdap/issues
+	Documentation = https://docs.fintrac.co.uk/versions/latest/modelling
+	Source Code = https://github.com/martin-traverse/tracdap
+	Issue Tracker = https://github.com/martin-traverse/tracdap/issues
 classifiers = 
-	Programming Language :: Python :: 3
 	Operating System :: OS Independent
+	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
+	Intended Audience :: Developers
+	Intended Audience :: End Users/Desktop
+	Intended Audience :: Financial and Insurance Industry
+	Topic :: Office/Business
+	Topic :: Office/Business :: Financial
+	Topic :: Software Development
+	Topic :: Software Development :: Libraries :: Application Frameworks
+	Topic :: Software Development :: Libraries :: Python Modules
 author = Martin Traverse
 author_email = martin@fintrac.co.uk
 
@@ -37,7 +50,7 @@ packages =
 package_dir = 
 	tracdap = src/tracdap
 	tracdap.rt = src/tracdap/rt
-python_requires = >= 3.9, < 3.14
+python_requires = >= 3.9
 install_requires = 
 	protobuf == 6.31.1
 	pyarrow == 21.0.0

{tracdap_runtime-0.9.1 → tracdap_runtime-0.9.2.dev4}/src/tracdap/rt/_version.py

@@ -13,4 +13,4 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
-__version__ = "0.9.1"
+__version__ = "0.9.2.dev4"

{tracdap_runtime-0.9.1 → tracdap_runtime-0.9.2.dev4}/src/tracdap/rt/launch/launch.py

@@ -73,7 +73,7 @@ def _resolve_config_file(
             return parent_config_path
 
         if model_dir is not None:
-            model_config_path = _search_parent_paths(cwd, config_path)
+            model_config_path = _search_parent_paths(model_dir, config_path)
             if model_config_path is not None:
                 return model_config_path
 
@@ -132,8 +132,11 @@ def launch_model(
     # Default to dev_mode = True for launch_model()
     dev_mode = launch_args["dev_mode"] if "dev_mode" in launch_args else True
 
-    model_file = _inspect.getfile(model_class)
-    model_dir = _pathlib.Path(model_file).parent
+    try:
+        model_file = _inspect.getfile(model_class)
+        model_dir = _pathlib.Path(model_file).parent
+    except OSError:
+        model_dir = None
 
     _sys_config = _resolve_config_file(sys_config, model_dir, dev_mode)
     _job_config = _resolve_config_file(job_config, model_dir, dev_mode)