diff --git a/README.md b/README.md index 441640c..983d43a 100644 --- a/README.md +++ b/README.md @@ -36,9 +36,9 @@ for example: `~/.jupyter/jupyter_notebook_config.py`, and specify your long-term ```python c = get_config() -c.DrivesConfig.access_key_id = "" -c.DrivesConfig.secret_access_key = "" -c.DrivesConfig.session_token = "" +c.DrivesConfig.access_key_id = "" +c.DrivesConfig.secret_access_key = "" +c.DrivesConfig.session_token = "" ``` ### Custom credentials file path @@ -51,13 +51,25 @@ c = get_config() c.DrivesConfig.custom_credentials_path = "path/to/file/containing/credentials" ``` +### Environment variables + +The credentials can also be set through environment variables that will be automatically extracted. + +````bash +export JP_DRIVES_PROVIDER="" +export JP_DRIVES_ACCESS_KEY_ID="" +export JP_DRIVES_SECRET_ACCESS_KEY="" +export JP_DRIVES_SESSION_TOKEN="" +export JP_DRIVES_CUSTOM_CREDENTIALS_PATH="" + + ## Uninstall To remove the extension, execute: ```bash pip uninstall jupyter_drives -``` +```` ## Troubleshoot