Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

clarify resource identifier docs #1437

Merged
merged 5 commits into from
May 1, 2024
Merged

clarify resource identifier docs #1437

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9637d0e
clarify resource identifier docs
asmacdo Apr 26, 2024
d8bae4d
Add examples
asmacdo Apr 26, 2024
16c41b6
line spacing
asmacdo Apr 27, 2024
3afd99b
Add specific file example
asmacdo Apr 28, 2024
58c7c4c
Add example for directory
asmacdo May 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions dandi/cli/cmd_download.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@
help=f"""\
Download files or entire folders from DANDI.

\b
{_dandi_url_parser.resource_identifier_primer}
\b
{_dandi_url_parser.known_patterns}
asmacdo marked this conversation as resolved.
Show resolved Hide resolved
"""
Expand Down
2 changes: 2 additions & 0 deletions dandi/cli/cmd_ls.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@
The arguments may be either resource identifiers or paths to local
files/directories.

\b
{_dandi_url_parser.resource_identifier_primer}
\b
{_dandi_url_parser.known_patterns}
"""
Expand Down
9 changes: 9 additions & 0 deletions dandi/dandiarchive.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -675,6 +675,15 @@ class _dandi_url_parser:
"https://<server>/...",
),
]
resource_identifier_primer = """dandi commands and accept URLs and URL-like identifiers called
asmacdo marked this conversation as resolved.
Show resolved Hide resolved
<resource ids> in the following formats for identifying Dandisets, assets, and asset
collections.

Text in [brackets] is optional. A server field is a base API or GUI URL
for a DANDI Archive instance. If an optional ``version`` field is omitted from
a URL, the given Dandiset's most recent published version will be used if it
has one, and its draft version will be used otherwise.
"""
known_patterns = "Accepted resource identifier patterns:" + "\n - ".join(
[""] + [display for _, _, display in known_urls]
)
Expand Down
Loading