Skip to main content

Python SDK for Igloo Cloud

Project description

Igloo Python Connector

Igloo Python Connector is a Python wrapper for the Igloo Cloud API. It also provides additional useful methods and examples.

Installation

Note, we assume you have a version of Python >= 3.10 and < 3.14 already installed on your machine. If not, please download and install Python 3.13 from the official website. Also note, we recommend that you perform the installation within a Python virtual environment. See here for more info.

Once created, please activate your virtual environment and install the Igloo Python Connector package using the following command:

pip install wtwco-igloo

You should now be able to import the package in your Python code:

import wtwco_igloo

Connecting to the API

Connect to the API with device code flow:

from wtwco_igloo import Connection

connection = Connection.from_device_code(api_url, client_id, tenant_id)

# View your workspaces
print(connection.get_workspaces())

Documentation and Examples

For documentation and examples please see WTW Client Services.

Release Notes

2.1

Improvements

  1. Interactive token is now the default authentication method used throughout the example code.
  2. New methods and an example (documentation_example.py) for getting all table documentation for a given model or project.
  3. Improved support for copying runs and projects with files between environments and workspaces.
  4. Improvements to Calculation Pools:
    • New CalculationPool class with information such as cores and memory.
    • Methods that perform calculations allow for a pool to be specified by name or id.
  5. Improvements to the Run class:
    • New method finalize for finalizing a run.
    • Several new methods for getting run results.
    • Two new methods (run_results_to_csv and run_result_table_nodes_to_csv) for exporting run results to CSV.
    • Comparison of run results with string values is now allowed.
    • And other quality of life improvements.
  6. Improvements to the Project class:
    • New properties added, including model and contains_finalized_runs.
    • Support for default pools with default_pool_name and default_pool_id properties.
    • New method update for refreshing state.
  7. New get_or_create_project method added to both Connection and Workspace classes.
  8. New method update added to the UploadedFile class for refreshing state.
  9. String comparisons for object names are case-insensitive.
  10. Added get_..._by_id methods for fetching pools, workspace, projects, files, and runs by id.
  11. Customisable backoff retrying for the following HTTP response status codes 429, 502, 503, 504.

Compatibility

  1. Support for Python 3.9 dropped as it is now end-of-life.

Bugfixes

  1. Fixed bug with empty workspaces failing to list projects.
  2. Fixed bug when copying projects with the same name across environments.
  3. Fixed bug where newly uploaded files would have upload_status be 'UploadNotStarted'.

Security

  1. Updated third-party package dependencies to pick up upstream security and stability fixes.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

wtwco_igloo-2.1.0-py3-none-any.whl (75.7 kB view details)

Uploaded Python 3

File details

Details for the file wtwco_igloo-2.1.0-py3-none-any.whl.

File metadata

  • Download URL: wtwco_igloo-2.1.0-py3-none-any.whl
  • Upload date:
  • Size: 75.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.2

File hashes

Hashes for wtwco_igloo-2.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 387bb42aea00aaec7eeec0596c4c37a4d2e1bca7c582e41ef951ff1777f64eb7
MD5 4ca6461da1f974772104ed3453e6666c
BLAKE2b-256 825f35cf4ce8d7baeb29dc4f2751e7032e79be1ce3b6c7e48882522fd74d6a0e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page