{"id":23894,"library":"intersystems-irispython","title":"InterSystems IRIS Python SDK","description":"Official InterSystems IRIS Python SDK for connecting to and interacting with InterSystems IRIS data platform. Current version 5.3.2, supporting Python >=3.8. Released on a per-release cadence aligned with IRIS updates.","status":"active","version":"5.3.2","language":"python","source_language":"en","source_url":"https://github.com/intersystems/iris-python-sdk","tags":["interSystems","IRIS","database","SDK","python","data platform"],"install":[{"cmd":"pip install intersystems-irispython","lang":"bash","label":"Install from PyPI"}],"dependencies":[{"reason":"Core SDK package","package":"intersystems_irispython","optional":false}],"imports":[{"note":"Common mistake; 'iris' is not the correct module name.","wrong":"import iris","symbol":"IRIS","correct":"from intersystems_irispython import IRIS"},{"note":"","wrong":null,"symbol":"iris","correct":"import intersystems_irispython.iris as iris"}],"quickstart":{"code":"import os\nfrom intersystems_irispython import IRIS\n\n# Connect using environment variables\nconn = IRIS.connection(\n    hostname=os.environ.get('IRIS_HOSTNAME', 'localhost'),\n    port=int(os.environ.get('IRIS_PORT', 1972)),\n    namespace=os.environ.get('IRIS_NAMESPACE', 'USER'),\n    username=os.environ.get('IRIS_USERNAME', '_SYSTEM'),\n    password=os.environ.get('IRIS_PASSWORD', '')\n)\nprint('Connected:', conn.is_connected())\nconn.close()","lang":"python","description":"Connect to IRIS using environment variables for credentials."},"warnings":[{"fix":"Replace `iris.create_connection(...)` with `IRIS.connection(...)`.","message":"In v5.x, the `IRIS.connection()` method replaced the old `iris.create_connection()` pattern from v4.x. Existing code using `create_connection` will break.","severity":"breaking","affected_versions":">=5.0.0"},{"fix":"Use `from intersystems_irispython import IRIS` (exact casing).","message":"The class name `IRIS` is all uppercase. A common mistake is to use `Iris` or `iris` (lowercase) which will raise AttributeError.","severity":"gotcha","affected_versions":"all"},{"fix":"Ensure port number matches IRIS Superserver port (default 1972).","message":"Default port is 1972 (Superserver), not 51773 or 9091. Using wrong port leads to connection timeout.","severity":"gotcha","affected_versions":"all"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Install the correct package: pip install intersystems-irispython, then use 'from intersystems_irispython import IRIS'.","cause":"Trying to import 'iris' instead of 'intersystems_irispython'.","error":"ModuleNotFoundError: No module named 'iris'"},{"fix":"Use 'from intersystems_irispython import IRIS'.","cause":"Incorrect import: 'import intersystems_irispython' then trying to use intersystems_irispython.IRIS but the class is inside the module but not directly accessible.","error":"AttributeError: module 'intersystems_irispython' has no attribute 'IRIS'"},{"fix":"Check hostname, port (default 1972), and ensure IRIS is running and listening on that port.","cause":"Wrong host, port, or IRIS instance not running.","error":"ConnectionError: [Errno 111] Connection refused"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}