diff --git a/docs/index.md b/docs/index.md index 34961a2..f9a3297 100644 --- a/docs/index.md +++ b/docs/index.md @@ -46,8 +46,8 @@ Omit variables for providers you do not intend to call; the CLI will prompt inte See the provider notes for step-by-step credential setup: -- [Genability / Arcadia](providers/arcadia/access.md) -- [OpenEI / NREL](providers/nrel/access.md) +- [Arcadia Signal API](providers/arcadia/access.md) +- [NREL URDB](providers/nrel/access.md) - [RateAcuity](providers/rateacuity/access.md) See the [CLI Usage Guide](cli-usage.md) for detailed command-line workflows and option reference. diff --git a/docs/providers/arcadia/access.md b/docs/providers/arcadia/access.md index 9919498..1f24c66 100644 --- a/docs/providers/arcadia/access.md +++ b/docs/providers/arcadia/access.md @@ -1,21 +1,24 @@ -# Arcadia Credentials & Access +# Arcadia Access & Credentials -## Credentials +## Obtaining Access -Set the following environment variables before invoking the CLI (export them or add them to a `.env` file): +To gain access to Arcadia (Genability), you need to create an account and generate application credentials: -```bash -ARCADIA_APP_ID=... -ARCADIA_APP_KEY=... -``` +1. [Create an Arcadia account](https://dash.genability.com/signup) if you don't already have one. +2. Log in and navigate to the [Applications dashboard](https://dash.genability.com/org/applications). +3. Create a new application. +4. Copy the Application ID and Application Key for the next step. -## Obtaining Access +## Setting Credentials -1. [Create an Arcadia (Genability) account](https://dash.genability.com/signup) if you do not already have credentials. -2. Navigate to the [Applications dashboard](https://dash.genability.com/org/applications). -3. Create a new application, then copy the Application ID/Key into the environment variables above (or your `.env` file). +`tariff_fetch` will read the credentials from the `ARCADIA_APP_ID` and `ARCADIA_APP_KEY` environment variables. -## Helpful Links +Either export them, or place them in your `.env` file: + +```bash +ARCADIA_APP_ID= +ARCADIA_APP_KEY= +``` -- Arcadia Applications dashboard: -- Tariffs API reference: +!!! warning "Important" + Make sure to add `.env` to your `.gitignore` file to avoid accidentally committing your credentials to version control. diff --git a/docs/providers/nrel/access.md b/docs/providers/nrel/access.md index fc71274..6156421 100644 --- a/docs/providers/nrel/access.md +++ b/docs/providers/nrel/access.md @@ -1,19 +1,21 @@ -# NREL / OpenEI Credentials & Access +# URDB Access & Credentials -## Credentials +## Obtaining Access -Set the `OPENEI_API_KEY` environment variable (export it or place it in your `.env` file): +To gain access to URDB, you need to obtain a simple API key from NREL. The process is simple: -```bash -OPENEI_API_KEY=... -``` +1. Request the API key through the [OpenEI API signup form](https://openei.org/services/api/signup/). +2. The key arrives via email, copy it for the next step. -## Obtaining Access +## Setting Credentials -1. Request an API key through the [OpenEI API signup form](https://openei.org/services/api/signup/). -2. The key arrives via email—copy it into `OPENEI_API_KEY`. +`tariff_fetch` will read the API key from the `OPENEI_API_KEY` environment variable. -## Helpful Links +Either export it, or place it in your `.env` file: + +```bash +OPENEI_API_KEY= +``` -- API signup: -- URDB API reference: +!!! warning "Important" + Make sure to add `.env` to your `.gitignore` file to avoid accidentally committing your credentials to version control. \ No newline at end of file diff --git a/docs/providers/rateacuity/access.md b/docs/providers/rateacuity/access.md index 2991420..25dbfa2 100644 --- a/docs/providers/rateacuity/access.md +++ b/docs/providers/rateacuity/access.md @@ -1,25 +1,28 @@ -# Rate Acuity Access & Runtime Notes +# RateAcuity Access & Credentials -## Credentials +## Obtaining Access + +There is no self-serve signup for RateAcuity. To gain access: + +1. [Contact RateAcuity](https://rateacuity.com/contact-us/) to request access to the web portal. +2. They will provide you with a username and password. Copy them for the next step. +3. They will start you off with a free trial, after which the username and password will become invalid unless you subscribe to the web portal product. + +## Setting Credentials + +`tariff_fetch` will read the credentials from the `RATEACUITY_USERNAME` and `RATEACUITY_PASSWORD` environment variables. -Set the following environment variables (via exports or a `.env` file) so the CLI can authenticate with the web portal: +Either export them, or place them in your `.env` file: ```bash -RATEACUITY_USERNAME=... -RATEACUITY_PASSWORD=... +RATEACUITY_USERNAME= +RATEACUITY_PASSWORD= ``` -## Obtaining Access - -1. There is no self-serve signup. [Contact Rate Acuity](https://rateacuity.com/contact-us/) to request portal access. -2. Use the provided username and password for both electric and gas workflows, storing them in your `.env` file if desired. +!!! warning "Important" + Make sure to add `.env` to your `.gitignore` file to avoid accidentally committing your credentials to version control. ## Runtime Notes - The CLI uses Selenium under the hood. Ensure Chrome or Chromium is installed so the automation can launch a browser session. - If an error occurs during scraping, a `selenium_error.png` screenshot is written to the working directory to help diagnose the failure. - -## Helpful Links - -- Access requests: -- Portal login: diff --git a/mkdocs.yml b/mkdocs.yml index b1c0681..cd7f641 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -63,6 +63,7 @@ plugins: paths: [src] markdown_extensions: + - admonition - toc: toc_depth: 3 - pymdownx.highlight: