From 86611c0d3ccea3ab1c71e78bb2df5e8212ebbcc2 Mon Sep 17 00:00:00 2001 From: LottR079 Date: Thu, 18 Dec 2025 20:48:01 +0100 Subject: [PATCH] docs: add environment configuration examples Added a file with examples of environment configuration for demo and production scenarios. --- ENVIRONMENT_EXAMPLES.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 ENVIRONMENT_EXAMPLES.md diff --git a/ENVIRONMENT_EXAMPLES.md b/ENVIRONMENT_EXAMPLES.md new file mode 100644 index 0000000..dd8e295 --- /dev/null +++ b/ENVIRONMENT_EXAMPLES.md @@ -0,0 +1,28 @@ +# Environment Configuration Examples + +This document illustrates a few example `.env` configurations for the Kalshi starter. + +## 1. Demo environment + +A basic configuration for running against a demo or sandbox environment: + + KALSHI_API_HOST=https://demo-api.kalshi.com/trade-api/v2 + KALSHI_API_KEY_ID=your-demo-key-id + KALSHI_PRIVATE_KEY_PATH=./demo_private_key.pem + +## 2. Production-like configuration + +An example for production-style setups: + + KALSHI_API_HOST=https://api.elections.kalshi.com/trade-api/v2 + KALSHI_API_KEY_ID=your-prod-key-id + KALSHI_PRIVATE_KEY_PATH=./prod_private_key.pem + +## 3. Logging and timeouts + +You can add optional variables to control behaviour in `main.py`: + + LOG_LEVEL=INFO + REQUEST_TIMEOUT_SECONDS=10 + +Keep secrets such as private keys out of version control and rotate them according to your security policy.