OpenEnergyPlatform / academy

The Open Energy Academy is a collection of courses, tutorials, and questions for the Open Energy Family
https://openenergyplatform.github.io/academy/
GNU Affero General Public License v3.0
16 stars 6 forks source link

Its not clear to the user how to set the oep api token in OEP Client Tutorial 04 #219

Closed jh-RLI closed 2 months ago

jh-RLI commented 2 months ago

Description of the issue

In OEP Client Tutorial 04 the user must setup the OEP API token as env. variable on his/her system. This step is not clear if it was not setup before.

Steps to Reproduce

  1. Use this tutorial: https://openenergyplatform.github.io/academy/tutorials/02_oep_client/04_client_cli_upload/#setup
  2. Set: SET token=%OEP_API_TOKEN%
  3. error

Ideas of solution

All tutorials should reference how to set the OEP API token.

Either always use:

  1. token = environ.get("OEP_API_TOKEN") or getpass("Enter your OEP API token:")

Or 2. set the OEP_API_TOKEN env. variable.

Workflow checklist

jh-RLI commented 2 months ago

https://openenergyplatform.github.io/academy/tutorials/99_other/beginners_guide/#1-things-you-only-need-to-do-once