From f536a38c8fb14cbaedbfa049355249b4df3503bd Mon Sep 17 00:00:00 2001 From: Aaron Kanzer Date: Fri, 25 Oct 2024 12:45:51 -0400 Subject: [PATCH] mini update --- docs/62_dandi_cli.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/62_dandi_cli.md b/docs/62_dandi_cli.md index 32630883..125a9b50 100644 --- a/docs/62_dandi_cli.md +++ b/docs/62_dandi_cli.md @@ -11,8 +11,8 @@ For example: ```python known_instances = { - "dandi": DandiInstance( - "dandi", + "dandi": DandiInstance( # Your own "dandi"" + "dandi", # Your own "dandi" "https://.org", # UI URL "https://api..org/api", # API URL ), @@ -29,6 +29,11 @@ known_instances = { } ``` +Of note, you'll need to think about how you manage API access via the CLI -- `dandi` relies of the presence of a `DANDI_API_KEY` +env. var [see here for code reference](https://github.com/dandi/dandi-cli/blob/6aa414c4db47394970f586cc4fb9758a634aef87/dandi/dandiapi.py#L492-L499) + +Dependent on the structure of your project, you might want to reflect a specific, unique environment variable value. + ## Handling Versioning DANDI CLI leverages a tool called [versioneer](https://pypi.org/project/versioneer/) for semantic versioning in PyPI.