Automatically upload the `.bidsignore` file to the Dandiset

[kabilar]

Following up on #1740. I added the dandiset.yaml entry to a .bidsignore file and was able to successfully upload the dataset_description.json without error.

Now when a collaborator wants to add data to this Dandiset, they download the Dandiset and must manually create a .bidsignore with dandiset.yaml. It would be helpful if the DANDI Client automatically uploads the .bidsignore to the Dandiset.

And even better, if the DANDI Client automatically creates a .bidsignore file with a dandiset.yaml entry for each Dandiset when it is downloaded for the first time.

Thank you.

[yarikoptic]

Now when a collaborator wants to add data to this Dandiset, they download the Dandiset and must manually create a .bidsignore with dandiset.yaml.

are you saying that after you uploaded .bidsignore it is not downloaded by the dandi-cli on a full dandiset download?

And even better, if the DANDI Client automatically creates a .bidsignore file with a dandiset.yaml entry for each Dandiset when it is downloaded for the first time.

how would it know that it is "for the first time" and not "second" or "third"?

[kabilar]

Thanks @yarikoptic.

Now when a collaborator wants to add data to this Dandiset, they download the Dandiset and must manually create a .bidsignore with dandiset.yaml.

are you saying that after you uploaded .bidsignore it is not downloaded by the dandi-cli on a full dandiset download?

If I recall correctly, I don't think the DANDI Client uploads the .bidsignore when running dandi upload. After running dandi upload, I did specifically delete my local Dandiset copy and ran a full Dandiset download. The .bidsignore was not present after the full Danidset download.

And even better, if the DANDI Client automatically creates a .bidsignore file with a dandiset.yaml entry for each Dandiset when it is downloaded for the first time.

how would it know that it is "for the first time" and not "second" or "third"?

If it's an empty Dandiset on dandiarchive.org.

[CodyCBakerPhD]

If it's an empty Dandiset on dandiarchive.org.

Empty Dandistes can be either NWB or BIDS, until the future when all NWB can be BIDS anyway

So right now it wouldn't make sense for NWB datasets to have the .bidsignore in them, and other organization tools (e.g., nwb2bids) will automatically create that when appropriate

[kabilar]

If it's an empty Dandiset on dandiarchive.org.

Empty Dandistes can be either NWB or BIDS, until the future when all NWB can be BIDS anyway

So right now it wouldn't make sense for NWB datasets to have the .bidsignore in them, and other organization tools (e.g., nwb2bids) will automatically create that when appropriate

That sounds good. We can postpone that piece of it.

[kabilar]

Confirming that the .bidsignore file is not recognized by the DANDI Client. And the log file does not mention it either.

$ ls -la
total 24
drwxr-xr-x  3 kabilar users 6144 Mar  5 11:18 .
drwxrwxrwx 15       0     0 6144 Mar  5 11:18 ..
-rw-r--r--  1 kabilar users   13 Mar  5 11:18 .bidsignore
drwxr-xr-x  2 kabilar users 6144 Mar  5 11:18 .ipynb_checkpoints
-rw-r--r--  1 kabilar users 1467 Feb 25 13:49 dandiset.yaml
-rw-r--r--  1 kabilar users  356 Mar  5 10:52 dataset_description.json

$ dandi upload
2026-03-05 11:19:03,962 [    INFO] Found 2 files to consider
PATH                     SIZE      ERRORS PROGRESS STATUS           MESSAGE                  
dandiset.yaml            1.5 kB                    skipped          should be edited online  
dataset_description.json 356 Bytes   0             skipped          file exists              
Summary:                 1.8 kB                    2 skipped        1 should be edited online
                                                                    1 file exists            
2026-03-05 11:19:05,286 [    INFO] Logs saved in /home/kabilar/.local/state/dandi-cli/log/2026.03.05-17.19.00Z-583.log