Skip to content

Commit c335f61

Browse files
committed
Update .gitignore to include generated production API keys file and enhance README with API key tier details
1 parent 57a8480 commit c335f61

3 files changed

Lines changed: 11 additions & 5 deletions

File tree

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# Ignore generated production API keys file
2+
.env.production.keys
13
# Ignore production API keys file
24
production_keys.json
35
# Byte-compiled / optimized / DLL files

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -132,13 +132,16 @@ This API requires an API key for all `/global/*` endpoints. Permits endpoints ar
132132
- Or use the `X-API-Key` header
133133
- Or as a query parameter: `?api_key=<your_api_key>` (for testing only)
134134

135+
135136
**API Key Tiers (example):**
136137

137-
| Tier | Example Key | Rate Limit | Features |
138-
|-------------|----------------------|----------------|---------------------------------|
139-
| Basic | `basic_xxxxxxxxxxxx` | 100/hour | emissions, countries, basic_stats |
140-
| Premium | `premium_xxxxxxxxxx` | 1000/hour | + stats, analytics, bulk_export |
141-
| Enterprise | `enterprise_xxxxxxx` | unlimited | all features |
138+
| Tier | Example Key | Rate Limit | Features |
139+
|-------------|--------------------------------------------------------|----------------|---------------------------------|
140+
| Basic | `basic_xxxxxxxxxx` | 100/hour | emissions, countries, basic_stats |
141+
| Premium | `premium_xxxxxxxxxx` | 1000/hour | + stats, analytics, bulk_export |
142+
| Enterprise | `enterprise_xxxxxxxxxxx` | unlimited | all features |
143+
144+
> **Note:** Production API keys are not published. Please request your key from the admin or support team.
142145

143146
> **Note:** Production API keys are not published. Please request your key from the admin or support team.
144147

generate_keys.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
12
#!/usr/bin/env python3
23
"""
34
Generate secure API keys for production use

0 commit comments

Comments
 (0)