Skip to content

docs: add environment configuration examples #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
LottR079 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add environment configuration examples #27

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions ENVIRONMENT_EXAMPLES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.