From 408f55278ea6813e56e23a6785903f5691a33c7b Mon Sep 17 00:00:00 2001 From: Natalia Borovskikh Date: Wed, 29 Oct 2025 13:05:53 +0000 Subject: [PATCH 1/2] Update README.md Close #8 #9 and #10 --- README.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 58feea8..5ebc256 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,17 @@ The project provides a CLI tool that retrieves electric and gas utility tariff d ## Requirements - Python 3.11+ - Credentials for the providers you intend to call: - - `ARCADIA_APP_ID` and `ARCADIA_APP_KEY` - - `OPENEI_API_KEY` - - `RATEACUITY_USERNAME` and `RATEACUITY_PASSWORD` + + - **Genability / Arcadia Data Platform**: `ARCADIA_APP_ID`, `ARCADIA_APP_KEY` + [Create an account](https://dash.genability.com/signup), navigate to [Applications dashboard](https://dash.genability.com/org/applications), create an application, then copy the Application ID and Key. + + - **OpenEI**: `OPENEI_API_KEY` + Request a key at the [OpenEI API signup](https://openei.org/services/api/signup/). The key arrives by email. + + - **RateAcuity Web Portal**: `RATEACUITY_USERNAME`, `RATEACUITY_PASSWORD` + There is no self-serve signup. [Contact RateAcuity](https://rateacuity.com/contact-us/) to request Web Portal access. No API key is required for `tariff_fetch`. + + - Google Chrome or Chromium installed locally (for RateAcuity) ## Configuration From af3a0b61f2e61d2c017069119f85da53d00677fc Mon Sep 17 00:00:00 2001 From: Natalia Borovskikh Date: Wed, 29 Oct 2025 13:52:45 +0000 Subject: [PATCH 2/2] Add some newlines in README.md for readability --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 5ebc256..e91d3d2 100644 --- a/README.md +++ b/README.md @@ -7,12 +7,15 @@ The project provides a CLI tool that retrieves electric and gas utility tariff d - Credentials for the providers you intend to call: - **Genability / Arcadia Data Platform**: `ARCADIA_APP_ID`, `ARCADIA_APP_KEY` + [Create an account](https://dash.genability.com/signup), navigate to [Applications dashboard](https://dash.genability.com/org/applications), create an application, then copy the Application ID and Key. - **OpenEI**: `OPENEI_API_KEY` + Request a key at the [OpenEI API signup](https://openei.org/services/api/signup/). The key arrives by email. - **RateAcuity Web Portal**: `RATEACUITY_USERNAME`, `RATEACUITY_PASSWORD` + There is no self-serve signup. [Contact RateAcuity](https://rateacuity.com/contact-us/) to request Web Portal access. No API key is required for `tariff_fetch`.