girder 5.0.5.dev4__tar.gz → 5.0.5.dev6__tar.gz

{girder-5.0.5.dev4/girder.egg-info → girder-5.0.5.dev6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: girder
-Version: 5.0.5.dev4
+Version: 5.0.5.dev6
 Summary: Web-based data management platform
 Home-page: https://girder.readthedocs.org
 Author: Kitware, Inc.

{girder-5.0.5.dev4 → girder-5.0.5.dev6}/docs/configuration.rst

@@ -56,7 +56,7 @@ within their own packages.
 Environment Variable List
 .........................
 
-This section is auto-generated from code inspection.
+This section, except for descriptions, is auto-generated from code inspection.  More descriptions will be added as users ask about settings.
 
 .. container:: full-width-section
 

{girder-5.0.5.dev4 → girder-5.0.5.dev6}/docs/list_env_settings.py

@@ -4,11 +4,16 @@
 
 import argparse
 import ast
+import os
 import re
 import subprocess
 import sys
 from pathlib import Path
 
+import yaml
+
+yaml_cache = {}
+
 
 def get_git_tracked_python_files(repo_root):
     result = subprocess.run(
@@ -332,6 +337,17 @@ def setting_key_to_env(key):
     return f"GIRDER_SETTING_{key.replace('.', '_').upper()}"
 
 
+def get_desc(key):
+    if not yaml_cache:
+        yaml_file = os.path.splitext(__file__)[0] + '.yaml'
+        try:
+            with open(yaml_file) as f:
+                yaml_cache.update(yaml.safe_load(f) or {})
+        except Exception:
+            yaml_cache[None] = None
+    return yaml_cache.get(key, '')
+
+
 def process_repo(repo_root, repo_label, exclude_pattern):
     py_files = get_git_tracked_python_files(repo_root)
     setting_entries = []
@@ -412,20 +428,22 @@ def main():
 
     print('# Girder Environment Variables\n')
     print('## Database-Stored Settings via Environment Variables\n')
-    print('| Environment Variable | Setting Key | Component | Repo | Source File |')
-    print('|---|---|---|---|---|')
+    print('| Environment Variable | Setting Key | Component | Repo | Source File | Description |')
+    print('|---|---|---|---|---|---|')
     for env_var in sorted(seen_settings.keys()):
         key, component, repo_label, path = seen_settings[env_var]
-        print(f'| `{env_var}` | `{key}` | {component} | {repo_label} | `{path}` |')
+        desc = get_desc(env_var)
+        print(f'| `{env_var}` | `{key}` | {component} | {repo_label} | `{path}` | {desc}')
 
     print('\n## Direct Environment Variables\n')
-    print('| Environment Variable | Component | Repo | Source File |')
-    print('|---|---|---|---|')
+    print('| Environment Variable | Component | Repo | Source File | Description |')
+    print('|---|---|---|---|---|')
     for env_var in sorted(seen_environ.keys()):
         component, repo_label, path = seen_environ[env_var]
+        desc = get_desc(env_var)
         if exclude_name_pattern and exclude_name_pattern.search(env_var):
             continue
-        print(f'| `{env_var}` | {component} | {repo_label} | `{path}` |')
+        print(f'| `{env_var}` | {component} | {repo_label} | `{path}` | {desc} |')
 
 
 if __name__ == '__main__':

girder-5.0.5.dev6/docs/list_env_settings.yaml

@@ -0,0 +1,4 @@
+# This yaml file has descriptions of _some_ of the environment variables to
+# augment the data shown in the auto-generated table
+GIRDER_WORKER_DOCKER_RUN_OPTIONS: >
+  A JSON dictionary of values to pass to all dockers that are created by Girder Worker.  For instance, you could always mount a specific directory and pass an environment variable like so: `{"volumes": ["/some/cache:/root/.cache"], "environment": {"CACHE_AVAILABLE": "1"}}`.  If the value is not a valid JSON dictionary it is ignored.  Keys of `detach` and `tty` are ignored.

{girder-5.0.5.dev4 → girder-5.0.5.dev6}/docs/requirements-docs.txt

@@ -3,3 +3,4 @@ Sphinx
 sphinx_rtd_theme
 packaging
 myst-parser
+pyyaml

{girder-5.0.5.dev4 → girder-5.0.5.dev6/girder.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: girder
-Version: 5.0.5.dev4
+Version: 5.0.5.dev6
 Summary: Web-based data management platform
 Home-page: https://girder.readthedocs.org
 Author: Kitware, Inc.

{girder-5.0.5.dev4 → girder-5.0.5.dev6}/girder.egg-info/SOURCES.txt

@@ -49,6 +49,7 @@ docs/favicon.ico
 docs/index.rst
 docs/license.png
 docs/list_env_settings.py
+docs/list_env_settings.yaml
 docs/migration-guide.rst
 docs/mount.rst
 docs/plugin-development.rst