Skip to content

Commit

Permalink
mini update
Browse files Browse the repository at this point in the history
  • Loading branch information
Aaron Kanzer authored and Aaron Kanzer committed Oct 25, 2024
1 parent 6c717d6 commit f536a38
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions docs/62_dandi_cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ For example:

```python
known_instances = {
"dandi": DandiInstance(
"dandi",
"dandi": DandiInstance( # Your own "dandi""
"dandi", # Your own "dandi"
"https://<your-domain>.org", # UI URL
"https://api.<your-domain>.org/api", # API URL
),
Expand All @@ -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.
Expand Down

0 comments on commit f536a38

Please sign in to comment.