Skip to content

Commit c9ae8e7

Browse files
committed
Add cligas tool to readme
1 parent 00fba11 commit c9ae8e7

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Tariff Fetch
22

3-
The project provides a CLI tool that retrieves electric utility tariff data from multiple providers.
3+
The project provides a CLI tool that retrieves electric and gas utility tariff data from multiple providers.
44

55
## Requirements
66
- Python 3.11+
@@ -52,6 +52,20 @@ Options:
5252

5353
Omitted options will trigger interactive prompts.
5454

55+
### Gas benchmark CLI
56+
57+
RateAcuity natural gas benchmarks use a separate entry point:
58+
59+
```bash
60+
uv run python -m tariff_fetch.cli_gas [OPTIONS]
61+
```
62+
63+
`just cligas` runs the same command.
64+
65+
Options:
66+
- `--state` / `-s`: two-letter state abbreviation (default: prompt)
67+
- `--output-folder` / `-o`: directory for exports (default: `./outputs`)
68+
5569
### Examples
5670

5771
```bash
@@ -72,5 +86,6 @@ can accept or override them.
7286
## Provider notes
7387
- **Genability**: choose customer classes and tariff types before selecting tariffs. Requires Arcadia credentials.
7488
- **OpenEI**: pick the sector and detail level, then select the returned tariffs. Requires `OPENEI_API_KEY`.
75-
- **RateAcuity**: Selenium session that logs in, picks a state, utility, and schedules. Stores the scraped sections as
89+
- **RateAcuity (electric)**: Selenium session that logs in, picks a state, utility, and schedules. Stores the scraped sections as
7690
JSON. A failure produces `selenium_error.png` for inspection.
91+
- **RateAcuity (gas)**: Uses the gas benchmark workflow and exports the selected schedules in the same JSON format. Credentials are identical to the electric flow.

0 commit comments

Comments
 (0)