greenpick 0.1.1__tar.gz → 0.1.3__tar.gz

{greenpick-0.1.1/src/greenpick.egg-info → greenpick-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: greenpick
-Version: 0.1.1
+Version: 0.1.3
 Summary: Design-time sustainability co-pilot (MCP server): greener, cheaper cloud infrastructure decisions with carbon + cost + latency tradeoffs.
 Author-email: "Data Science Advisers, LLC" <info@datascienceadvisers.com>
 License-Expression: MIT
@@ -193,8 +193,9 @@ See `docs/user-questions-backlog.md`.
 - Instance-family efficiency: directional perf-per-watt multipliers (`data/instance_families.json`).
 - Latency: great-circle distance from region coordinates to the user's location.
 
-Set `EIA_API_KEY` and `ENTSOE_TOKEN` in `.env` (both free) for live carbon; `GREENPICK_CARBON_SOURCE`
-selects the source (`auto` routes US→EIA, EU→ENTSO-E, else mock).
+Set `EIA_API_KEY` and `ENTSOE_TOKEN` (both free) for live carbon — see
+[Turn on live data](#turn-on-live-data); `GREENPICK_CARBON_SOURCE` selects the source (`auto` routes
+US→EIA, EU→ENTSO-E, else mock).
 
 The data layer is a swappable repository (`MOCK` by default, works offline). Nothing here invents
 numbers: the LLM writes the *rationale*, the code supplies the *figures*.
@@ -227,11 +228,50 @@ pytest                          # run tests
 Connect it to an MCP client (e.g. Kiro / Claude Code / Cursor) by pointing the client at
 `python -m greenpick` in this directory. See `.env.example` for switching the data source.
 
+### Turn on live data
+
+GreenPick runs on labelled mock data until you give it two free keys:
+[EIA](https://www.eia.gov/opendata/register.php) (US grid) and
+[ENTSO-E](https://transparency.entsoe.eu/) (EU grid). Pass them as environment variables.
+(A `.env` file works for a source checkout; if you installed with `pip install greenpick`, use one
+of the options below.)
+
+**In an MCP client** (Kiro, Claude Desktop, Cursor…), add an `env` block to the server entry:
+
+```json
+{
+  "mcpServers": {
+    "greenpick": {
+      "command": "python",
+      "args": ["-m", "greenpick"],
+      "env": {
+        "GREENPICK_CARBON_SOURCE": "auto",
+        "EIA_API_KEY": "your-eia-key",
+        "ENTSOE_TOKEN": "your-entsoe-token"
+      }
+    }
+  }
+}
+```
+
+**In a Jupyter notebook or Python script**, set them before you start (or import) the server:
+
+```python
+import os
+os.environ["GREENPICK_CARBON_SOURCE"] = "auto"
+os.environ["EIA_API_KEY"] = "your-eia-key"
+os.environ["ENTSOE_TOKEN"] = "your-entsoe-token"
+```
+
+Every carbon figure includes a `quality` field: `live` means real grid data, `mock` means a
+fallback value. Check it to confirm live data is on.
+
 ## FAQ
 
 **Do I need API keys?** No — GreenPick runs on clearly-labelled mock data out of the box. For *live*
-carbon, set two free keys in `.env` (`EIA_API_KEY` for US, `ENTSOE_TOKEN` for EU) and
-`GREENPICK_CARBON_SOURCE=auto`. Without them it still works; it just says `quality: "mock"`.
+carbon, set two free keys (`EIA_API_KEY` for US, `ENTSOE_TOKEN` for EU) and
+`GREENPICK_CARBON_SOURCE=auto` — see [Turn on live data](#turn-on-live-data). Without them it still
+works; it just says `quality: "mock"`.
 
 **Why "directional" and not audited numbers?** Because it's for a *design-time decision*, not a
 compliance report. "Stockholm is ~30× cleaner than Sydney" is what you need to pick a region in

{greenpick-0.1.1 → greenpick-0.1.3}/README.md

@@ -163,8 +163,9 @@ See `docs/user-questions-backlog.md`.
 - Instance-family efficiency: directional perf-per-watt multipliers (`data/instance_families.json`).
 - Latency: great-circle distance from region coordinates to the user's location.
 
-Set `EIA_API_KEY` and `ENTSOE_TOKEN` in `.env` (both free) for live carbon; `GREENPICK_CARBON_SOURCE`
-selects the source (`auto` routes US→EIA, EU→ENTSO-E, else mock).
+Set `EIA_API_KEY` and `ENTSOE_TOKEN` (both free) for live carbon — see
+[Turn on live data](#turn-on-live-data); `GREENPICK_CARBON_SOURCE` selects the source (`auto` routes
+US→EIA, EU→ENTSO-E, else mock).
 
 The data layer is a swappable repository (`MOCK` by default, works offline). Nothing here invents
 numbers: the LLM writes the *rationale*, the code supplies the *figures*.
@@ -197,11 +198,50 @@ pytest                          # run tests
 Connect it to an MCP client (e.g. Kiro / Claude Code / Cursor) by pointing the client at
 `python -m greenpick` in this directory. See `.env.example` for switching the data source.
 
+### Turn on live data
+
+GreenPick runs on labelled mock data until you give it two free keys:
+[EIA](https://www.eia.gov/opendata/register.php) (US grid) and
+[ENTSO-E](https://transparency.entsoe.eu/) (EU grid). Pass them as environment variables.
+(A `.env` file works for a source checkout; if you installed with `pip install greenpick`, use one
+of the options below.)
+
+**In an MCP client** (Kiro, Claude Desktop, Cursor…), add an `env` block to the server entry:
+
+```json
+{
+  "mcpServers": {
+    "greenpick": {
+      "command": "python",
+      "args": ["-m", "greenpick"],
+      "env": {
+        "GREENPICK_CARBON_SOURCE": "auto",
+        "EIA_API_KEY": "your-eia-key",
+        "ENTSOE_TOKEN": "your-entsoe-token"
+      }
+    }
+  }
+}
+```
+
+**In a Jupyter notebook or Python script**, set them before you start (or import) the server:
+
+```python
+import os
+os.environ["GREENPICK_CARBON_SOURCE"] = "auto"
+os.environ["EIA_API_KEY"] = "your-eia-key"
+os.environ["ENTSOE_TOKEN"] = "your-entsoe-token"
+```
+
+Every carbon figure includes a `quality` field: `live` means real grid data, `mock` means a
+fallback value. Check it to confirm live data is on.
+
 ## FAQ
 
 **Do I need API keys?** No — GreenPick runs on clearly-labelled mock data out of the box. For *live*
-carbon, set two free keys in `.env` (`EIA_API_KEY` for US, `ENTSOE_TOKEN` for EU) and
-`GREENPICK_CARBON_SOURCE=auto`. Without them it still works; it just says `quality: "mock"`.
+carbon, set two free keys (`EIA_API_KEY` for US, `ENTSOE_TOKEN` for EU) and
+`GREENPICK_CARBON_SOURCE=auto` — see [Turn on live data](#turn-on-live-data). Without them it still
+works; it just says `quality: "mock"`.
 
 **Why "directional" and not audited numbers?** Because it's for a *design-time decision*, not a
 compliance report. "Stockholm is ~30× cleaner than Sydney" is what you need to pick a region in

{greenpick-0.1.1 → greenpick-0.1.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "greenpick"
-version = "0.1.1"
+version = "0.1.3"
 description = "Design-time sustainability co-pilot (MCP server): greener, cheaper cloud infrastructure decisions with carbon + cost + latency tradeoffs."
 readme = "README.md"
 requires-python = ">=3.11"

{greenpick-0.1.1 → greenpick-0.1.3}/src/greenpick/__init__.py

@@ -4,4 +4,4 @@ Greener cloud-region choices with honest carbon + cost + latency tradeoffs,
 delivered inside the vibe-coding loop. Directional guidance, not audited accounting.
 """
 
-__version__ = "0.1.1"
+__version__ = "0.1.3"

{greenpick-0.1.1 → greenpick-0.1.3}/src/greenpick/server.py

@@ -345,5 +345,5 @@ def explain_methodology_and_limits() -> dict:
         "forecast": "Day-ahead forecast is RELATIVE: upcoming hours ranked by forecast wind+solar output (ENTSO-E A69), not an absolute gCO2/kWh forecast. EU only; US/uncovered zones degrade to the recent historical pattern (labelled 'historical').",
         "data_residency": "GreenPick flags when a recommended move CROSSES a jurisdiction (esp. leaving the EEA) as a geographic heads-up only. It does NOT assess legal/GDPR compliance, does not encode adequacy decisions, and is not legal advice — confirm with your own data governance.",
         "ignored": "Embodied/hardware carbon and provider renewable-energy certificates.",
-        "data_sources": "Electricity Maps free tier (primary); ENTSO-E / EIA / NESO fallbacks; annual averages offline.",
+        "data_sources": "GREENPICK_CARBON_SOURCE=auto routes US regions to EIA-930 and EU regions to ENTSO-E (both free, live); other regions, or any region without a key, use clearly-labelled mock data. Electricity Maps is available when selected explicitly (GREENPICK_CARBON_SOURCE=electricitymaps).",
     }

{greenpick-0.1.1 → greenpick-0.1.3/src/greenpick.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: greenpick
-Version: 0.1.1
+Version: 0.1.3
 Summary: Design-time sustainability co-pilot (MCP server): greener, cheaper cloud infrastructure decisions with carbon + cost + latency tradeoffs.
 Author-email: "Data Science Advisers, LLC" <info@datascienceadvisers.com>
 License-Expression: MIT
@@ -193,8 +193,9 @@ See `docs/user-questions-backlog.md`.
 - Instance-family efficiency: directional perf-per-watt multipliers (`data/instance_families.json`).
 - Latency: great-circle distance from region coordinates to the user's location.
 
-Set `EIA_API_KEY` and `ENTSOE_TOKEN` in `.env` (both free) for live carbon; `GREENPICK_CARBON_SOURCE`
-selects the source (`auto` routes US→EIA, EU→ENTSO-E, else mock).
+Set `EIA_API_KEY` and `ENTSOE_TOKEN` (both free) for live carbon — see
+[Turn on live data](#turn-on-live-data); `GREENPICK_CARBON_SOURCE` selects the source (`auto` routes
+US→EIA, EU→ENTSO-E, else mock).
 
 The data layer is a swappable repository (`MOCK` by default, works offline). Nothing here invents
 numbers: the LLM writes the *rationale*, the code supplies the *figures*.
@@ -227,11 +228,50 @@ pytest                          # run tests
 Connect it to an MCP client (e.g. Kiro / Claude Code / Cursor) by pointing the client at
 `python -m greenpick` in this directory. See `.env.example` for switching the data source.
 
+### Turn on live data
+
+GreenPick runs on labelled mock data until you give it two free keys:
+[EIA](https://www.eia.gov/opendata/register.php) (US grid) and
+[ENTSO-E](https://transparency.entsoe.eu/) (EU grid). Pass them as environment variables.
+(A `.env` file works for a source checkout; if you installed with `pip install greenpick`, use one
+of the options below.)
+
+**In an MCP client** (Kiro, Claude Desktop, Cursor…), add an `env` block to the server entry:
+
+```json
+{
+  "mcpServers": {
+    "greenpick": {
+      "command": "python",
+      "args": ["-m", "greenpick"],
+      "env": {
+        "GREENPICK_CARBON_SOURCE": "auto",
+        "EIA_API_KEY": "your-eia-key",
+        "ENTSOE_TOKEN": "your-entsoe-token"
+      }
+    }
+  }
+}
+```
+
+**In a Jupyter notebook or Python script**, set them before you start (or import) the server:
+
+```python
+import os
+os.environ["GREENPICK_CARBON_SOURCE"] = "auto"
+os.environ["EIA_API_KEY"] = "your-eia-key"
+os.environ["ENTSOE_TOKEN"] = "your-entsoe-token"
+```
+
+Every carbon figure includes a `quality` field: `live` means real grid data, `mock` means a
+fallback value. Check it to confirm live data is on.
+
 ## FAQ
 
 **Do I need API keys?** No — GreenPick runs on clearly-labelled mock data out of the box. For *live*
-carbon, set two free keys in `.env` (`EIA_API_KEY` for US, `ENTSOE_TOKEN` for EU) and
-`GREENPICK_CARBON_SOURCE=auto`. Without them it still works; it just says `quality: "mock"`.
+carbon, set two free keys (`EIA_API_KEY` for US, `ENTSOE_TOKEN` for EU) and
+`GREENPICK_CARBON_SOURCE=auto` — see [Turn on live data](#turn-on-live-data). Without them it still
+works; it just says `quality: "mock"`.
 
 **Why "directional" and not audited numbers?** Because it's for a *design-time decision*, not a
 compliance report. "Stockholm is ~30× cleaner than Sydney" is what you need to pick a region in