feat: Add logging config, explain API key support, closses #75

VorTECHsa · Nov 25, 2019 · 97fd753 · 97fd753
1 parent 5903c97
commit 97fd753
Show file tree

Hide file tree

Showing 7 changed files with 16 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -20,6 +20,9 @@ $ pip install vortexasdk
 
 Set your `VORTEXA_API_KEY` environment variable, that's all.
 
+Refer to [Vortexa API Authentication](https://docs.vortexa.com/reference/intro-authentication)
+ for more details, including instructions on where to find your API key.
+
 ##### Example
 
 ```python

diff --git a/docs/build_docs.sh b/docs/build_docs.sh
@@ -1,4 +1,5 @@
 #!/bin/bash
 
+mkdir -p ./_build/pydocmd/examples
 python docs/autogen.py
 pydocmd build
diff --git a/docs/config/config.md b/docs/config/config.md
@@ -0,0 +1,9 @@
+## Config
+
+The VortexaSDK can be configured using environment variables.
+
+| Environment Variable  | Default                         | Description              |
+|:----------------------|:--------------------------------|:-------------------------|
+| VORTEXA_API_KEY       | none                            | API Key used to access the VortexaAPI. Refer to [Vortexa API Authentication](https://docs.vortexa.com/reference/intro-authentication) for more details, including instructions on where to find your API key.|
+| LOG_FILE              | vortexasdk.log                  | Output log file          |
+| LOG_LEVEL             | INFO                            | Configure the level of must be one of `["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"]` |
diff --git a/docs/deploy_docs.sh b/docs/deploy_docs.sh
@@ -1,4 +1,5 @@
 #!/bin/bash
 
+mkdir -p ./_build/pydocmd/examples
 python docs/autogen.py
 pydocmd gh-deploy
diff --git a/docs/entities/about-entities.md b/docs/entities/about-entities.md
diff --git a/docs/serve_docs.sh b/docs/serve_docs.sh
@@ -1,4 +1,5 @@
 #!/bin/bash
 
+mkdir -p ./_build/pydocmd/examples
 python docs/autogen.py
 pydocmd serve
diff --git a/pydocmd.yml b/pydocmd.yml
@@ -16,7 +16,6 @@ generate:
   - endpoints/products.md:
       - vortexasdk.endpoints.products++
       - vortexasdk.endpoints.products_result++
-
   - entities/product.md:
       - vortexasdk.api.product++
   - entities/geography.md:
@@ -37,15 +36,14 @@ pages:
       Products: endpoints/products.md
       Vessels: endpoints/vessels.md
   - Entities:
-#      About Entities: entities/about-entities.md << docs/entities/about-entities.md
       Cargo Movement: entities/cargo_movement.md
       Corporation: entities/corporation.md
       Geography: entities/geography.md
       Product: entities/product.md
       Vessel: entities/vessel.md
+  - Config: config.md << docs/config/config.md
   - Examples:
       1 China VLCC Discharges: examples/1_china.md
-
 theme:
   name: readthedocs
   collapse_navigation: true