TNFR-Python-Engine/.env.example at main · fermga/TNFR-Python-Engine · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
# TNFR Engine Environment Configuration
# Copy this file to .env and fill in your actual values
# NEVER commit .env files with real credentials to version control

# ============================================================================
# Development Configuration
# ============================================================================

# PyPI Publishing Configuration (for release scripts)
# Use API tokens for enhanced security: https://pypi.org/help/#apitoken
PYPI_USERNAME=__token__
PYPI_PASSWORD=pypi-XXXXXXXXXXXXXXXXXXXXXXXX  # Your PyPI API token
PYPI_API_TOKEN=pypi-XXXXXXXXXXXXXXXXXXXXXXXX  # Alternative name
TWINE_USERNAME=__token__
TWINE_PASSWORD=pypi-XXXXXXXXXXXXXXXXXXXXXXXX  # Your PyPI API token
PYPI_REPOSITORY=pypi  # or 'testpypi' for testing

# GitHub Configuration (for security dashboard and CI scripts)
GITHUB_TOKEN=ghp_XXXXXXXXXXXXXXXXXXXXXXXX  # GitHub Personal Access Token
GITHUB_REPOSITORY=fermga/TNFR-Python-Engine  # Format: owner/repo

# Redis Configuration (for RedisCacheLayer with authentication)
REDIS_HOST=localhost
REDIS_PORT=6379
REDIS_PASSWORD=your-redis-password-here
REDIS_DB=0
REDIS_USE_TLS=false

# Cache Signing Configuration (for hardened cache security)
# Generate a strong random secret: python -c "import secrets; print(secrets.token_hex(32))"
TNFR_CACHE_SECRET=  # 64-character hex string recommended

# ============================================================================
# TNFR Engine Configuration
# ============================================================================

# Logging Configuration
TNFR_LOG_LEVEL=INFO  # DEBUG, INFO, WARNING, ERROR, CRITICAL

# Reproducibility Configuration
TNFR_RANDOM_SEED=42  # For deterministic simulations

# Performance Configuration
TNFR_BACKEND=numpy  # numpy, jax, or torch
TNFR_CACHE_ENABLED=true

# ============================================================================
# Security Best Practices
# ============================================================================
#
# 1. NEVER commit this file with real credentials
# 2. Use API tokens instead of passwords where possible
# 3. Rotate credentials regularly
# 4. Use different credentials for development, staging, and production
# 5. Store production secrets in secure secret management systems
# 6. Grant minimal necessary permissions to all tokens
# 7. Revoke tokens immediately if compromised
#
# For more information, see SECURITY.md