Release v0.1.2 (What’s new?).
Welcome to which_runtime Documentation¶
In modern software development, especially in cloud and DevOps environments, the same codebase often runs across multiple runtime environments. The which_runtime library provides a powerful, centralized solution for detecting and managing different computational contexts.
What is a Runtime?¶
A runtime is a specific computational environment where your code executes. This could be:
Local development machine
Cloud environments (AWS Lambda, EC2, Batch)
Continuous Integration (CI) platforms (GitHub Actions, CodeBuild)
Development environments (Cloud9)
Containerized environments
Why Runtime Detection Matters¶
Different runtimes often require different configurations and behaviors:
Authentication methods vary (local AWS CLI profiles vs. IAM roles)
Resource access differs between environments
Logging and monitoring approaches change
Environment-specific optimizations
Key Features¶
Detect runtime environment with simple boolean checks
Support for multiple runtime types (local, cloud, CI)
Lightweight and easy to integrate
Helps create adaptive, environment-aware code
Quick Example¶
from which_runtime.api import runtime
if runtime.is_aws_lambda:
# Lambda-specific configuration
use_lambda_credentials()
elif runtime.is_local:
# Local development setup
use_local_aws_profile()
Install¶
which_runtime is released on PyPI, so all you need is to:
$ pip install which-runtime
To upgrade to latest version:
$ pip install --upgrade which-runtime