CHANGELOG.md

0.11.0 (Tue Jan 07 2025)

🚀 Enhancement

• Upgrade to datacite v4.5 serialization from inveniosoftware #261 (@yarikoptic)
• Add "version" to datacite record and bundle datacite json serializations #260 (@yarikoptic)
• Drop Python 3.8 support (remove typing_extensions from depends) #262 (@yarikoptic)

🐛 Bug Fix

• Use title in place of examples #271 (@waxlamp @satra @pre-commit-ci[bot])
• RF: detect BIDS based on having dataset_description.json #263 (@yarikoptic)
• Add support for detection and addition of ome/ngff "standard" into assets summary #252 (@yarikoptic)

🏠 Internal

• gh-actions: Bump codecov/codecov-action from 4 to 5 #267 (@dependabot[bot])
• [pre-commit.ci] pre-commit autoupdate (black 24.8.0 → 24.10.0; pre-commit-hooks: v4.6.0 → v5.0.0) #253 (@pre-commit-ci[bot])

📝 Documentation

• doc: A comment on current identification of URI and missing space into a description string #265 (@yarikoptic)

Authors: 5

• @dependabot[bot]
• @pre-commit-ci[bot]
• Roni Choudhury (@waxlamp)
• Satrajit Ghosh (@satra)
• Yaroslav Halchenko (@yarikoptic)

---

0.10.4 (Thu Sep 05 2024)

🐛 Bug Fix

• Properly handle failed requests to retrieve the schema #251 (@danlamanna)
• ENH: adopt sanitize_value from dandi-cli and use for sanitization of identifier #175 (@yarikoptic)
• [pre-commit.ci] pre-commit autoupdate #243 (@pre-commit-ci[bot])

🔩 Dependency Updates

• Declare typing_extensions dependency #248 (@jwodder)

Authors: 4

• @pre-commit-ci[bot]
• Dan LaManna (@danlamanna)
• John T. Wodder II (@jwodder)
• Yaroslav Halchenko (@yarikoptic)

---

0.10.3 (Mon Aug 12 2024)

🐛 Bug Fix

• Move pattern specification for BaseType.identifier to the annotation for the str type #247 (@candleindark)

Authors: 1

• Isaac To (@candleindark)

---

0.10.2 (Wed Jul 10 2024)

🐛 Bug Fix

• Use discriminated unions to provide more helpful error messages #245 (@mvandenburgh)
• Set the $schema key with the schema dialect #236 (@candleindark)
• Add validator to ensure a contact person has email provided #235 (@candleindark)

🏠 Internal

• [pre-commit.ci] pre-commit autoupdate #241 (@pre-commit-ci[bot])
• [pre-commit.ci] pre-commit autoupdate #237 (@pre-commit-ci[bot])
• [pre-commit.ci] pre-commit autoupdate #234 (@pre-commit-ci[bot])

🧪 Tests

• GitHub tests.yml CI: explicitly specify macos-12 and use python 3.11 to test against dandi-cli #238 (@yarikoptic)

Authors: 4

• @pre-commit-ci[bot]
• Isaac To (@candleindark)
• Mike VanDenburgh (@mvandenburgh)
• Yaroslav Halchenko (@yarikoptic)

---

0.10.1 (Mon Mar 18 2024)

🐛 Bug Fix

• Update auto version number #233 (@satra)
• Add ResourceType enum and associate with Resource model #232 (@bendichter @pre-commit-ci[bot])
• [pre-commit.ci] pre-commit autoupdate #229 (@pre-commit-ci[bot])

Authors: 3

• @pre-commit-ci[bot]
• Ben Dichter (@bendichter)
• Satrajit Ghosh (@satra)

---

0.10.0 (Mon Feb 12 2024)

🚀 Enhancement

• Remove Zarr checksum code #217 (@jwodder)

🐛 Bug Fix

• [pre-commit.ci] pre-commit autoupdate #219 (@pre-commit-ci[bot])

🏠 Internal

• gh-actions: Bump codecov/codecov-action from 3 to 4 #222 (@dependabot[bot] @jwodder)

🧪 Tests

• Move TempKlasses outside of test functions #224 (@jwodder)

Authors: 3

• @dependabot[bot]
• @pre-commit-ci[bot]
• John T. Wodder II (@jwodder)

---

0.9.1 (Tue Jan 30 2024)

🐛 Bug Fix

• Allow dictionary representation of Dandiset to have extra attributes #218 (@candleindark)

🧪 Tests

• Remove unneeded mark to fixture #221 (@candleindark)

Authors: 1

• Isaac To (@candleindark)

---

0.9.0 (Mon Jan 22 2024)

🚀 Enhancement

• Update to supporting Pydantic V2 #203 (@candleindark @satra @yarikoptic @pre-commit-ci[bot])

🐛 Bug Fix

• [pre-commit.ci] pre-commit autoupdate #211 (@pre-commit-ci[bot])
• Give version2tuple() a better type annotation #208 (@jwodder)
• Add __all__ to __init__.py #195 (@jwodder)
• Remove 3.7 #193 (@yarikoptic)
• [pre-commit.ci] pre-commit autoupdate #192 (@pre-commit-ci[bot])
• [pre-commit.ci] pre-commit autoupdate #188 (@pre-commit-ci[bot])
• [pre-commit.ci] pre-commit autoupdate #186 (@pre-commit-ci[bot])

🏎 Performance

• OPT: (memory) cache schema files upon first read from github #213 (@yarikoptic)

🏠 Internal

• [pre-commit.ci] pre-commit autoupdate #215 (@pre-commit-ci[bot])
• [pre-commit.ci] pre-commit autoupdate #212 (@pre-commit-ci[bot])
• gh-actions: Bump actions/setup-python from 4 to 5 #210 (@dependabot[bot] @satra)
• Remove typing_extensions imports #207 (@jwodder)
• Unpin versioningit version #196 (@jwodder)
• [pre-commit.ci] pre-commit autoupdate #200 (@pre-commit-ci[bot])
• gh-actions: Bump actions/checkout from 3 to 4 #191 (@dependabot[bot])

🧪 Tests

• Rerun failing test_dandimeta_datacite tests #199 (@jwodder)
• mypy: Set ignore_missing_imports = False #197 (@jwodder)
• Test against Python 3.12 #198 (@jwodder)
• Update README.md - more about use of the library + a few hyperlinks to files and projects #197 (@yarikoptic)

Authors: 6

• @dependabot[bot]
• @pre-commit-ci[bot]
• Isaac To (@candleindark)
• John T. Wodder II (@jwodder)
• Satrajit Ghosh (@satra)
• Yaroslav Halchenko (@yarikoptic)

---

0.8.4 (Fri Jun 16 2023)

🐛 Bug Fix

• added funderidtype and support for funder and sponsor roles to datacite metadata #167 (@satra @pre-commit-ci[bot] @djarecka)

🧪 Tests

• Add mypy to test extra_requires since needed for type hints testing #174 (@yarikoptic)

Authors: 4

• @pre-commit-ci[bot]
• Dorota Jarecka (@djarecka)
• Satrajit Ghosh (@satra)
• Yaroslav Halchenko (@yarikoptic)

---

0.8.3 (Mon Apr 17 2023)

🏠 Internal

• [pre-commit.ci] pre-commit autoupdate #170 (@pre-commit-ci[bot])

🔩 Dependency Updates

• Restrict pydantic requirement to < 2.0 #177 (@jwodder)

Authors: 2

• @pre-commit-ci[bot]
• John T. Wodder II (@jwodder)

---

0.8.2 (Thu Mar 16 2023)

🐛 Bug Fix

• fix: add 0.6.3 to validation #165 (@satra)

Authors: 1

• Satrajit Ghosh (@satra)

---

0.8.1 (Mon Mar 06 2023)

🐛 Bug Fix

• Fix type annotation of unvalidated() #163 (@jwodder)

Authors: 1

• John T. Wodder II (@jwodder)

---

0.8.0 (Mon Mar 06 2023)

🚀 Enhancement

• Fully type-annotate and type-check everything #100 (@jwodder @yarikoptic)

🐛 Bug Fix

• Use GitHub for Flake8 pre-commit hook #154 (@danlamanna)
• Properly include "data packages" in project #138 (@jwodder)

🏠 Internal

• Autoupdate .pre-commit-config.yaml #161 (@jwodder)
• Configure Dependabot to update GitHub Actions action versions #149 (@jwodder @satra)
• Update GitHub Actions to use ubuntu-latest #150 (@jwodder)
• Update GitHub Actions action versions #148 (@jwodder)
• Set action step outputs via $GITHUB_OUTPUT #147 (@jwodder)
• Update pre-commit hooks and rerun #145 (@jwodder)
• Update how jsonschema format checkers are retrieved #146 (@jwodder)

📝 Documentation

• dandi-schema readme edit #152 (@melster1010)

🧪 Tests

• Install dandi's extras extra when testing #162 (@jwodder)
• Test against Python 3.11 #151 (@jwodder)
• Revert "Set DJANGO_DANDI_WEB_APP_URL for dandi-cli integration tests" #137 (@yarikoptic)

Authors: 5

• Dan LaManna (@danlamanna)
• John T. Wodder II (@jwodder)
• Mary Elise Dedicke (@melster1010)
• Satrajit Ghosh (@satra)
• Yaroslav Halchenko (@yarikoptic)

---

0.7.1 (Thu Apr 28 2022)

🐛 Bug Fix

• add 0.6.2 to validation schemas #133 (@satra)

🧪 Tests

• Set DJANGO_DANDI_WEB_APP_URL for dandi-cli integration tests #132 (@jwodder)

Authors: 2

• John T. Wodder II (@jwodder)
• Satrajit Ghosh (@satra)

---

0.7.0 (Wed Apr 06 2022)

🚀 Enhancement

• ENH/RF: do not enforce any DANDI instance by default, support DJANGO_DANDI_WEB_APP_URL env var to specify one #128 (@yarikoptic)

🧪 Tests

• Directly base Docker image off of dandi-archive image #126 (@jwodder)
• Update dandi-archive Dockerfile to use Python 3.9 #125 (@jwodder)

Authors: 2

• John T. Wodder II (@jwodder)
• Yaroslav Halchenko (@yarikoptic)

---

0.6.0 (Thu Mar 17 2022)

🚀 Enhancement

• fix: add type of id to hasMember #123 (@satra)
• Update zarr checksums #120 (@dchiquito @satra)

Authors: 2

• Daniel Chiquito (@dchiquito)
• Satrajit Ghosh (@satra)

---

0.5.3 (Mon Mar 07 2022)

🐛 Bug Fix

• Unify version pattern, allow local dandiset URLs #121 (@AlmightyYakob @satra)

Authors: 2

• Jacob Nesbitt (@AlmightyYakob)
• Satrajit Ghosh (@satra)

---

0.5.2 (Mon Jan 31 2022)

🐛 Bug Fix

• Specify part generator to DandiETag class #117 (@AlmightyYakob)
• Define PartGenerator default part size as class member #116 (@AlmightyYakob)

Authors: 1

• Jacob Nesbitt (@AlmightyYakob)

---

0.5.1 (Sat Jan 15 2022)

🐛 Bug Fix

• Various edge case fixes #112 (@satra)
• get_checksum(): Error on empty input #113 (@jwodder)
• adding Orcid ID to the contributors #111 (@djarecka @satra)
• Zarr checksum calculation #109 (@dchiquito)

Authors: 4

• Daniel Chiquito (@dchiquito)
• Dorota Jarecka (@djarecka)
• John T. Wodder II (@jwodder)
• Satrajit Ghosh (@satra)

---

0.5.0 (Tue Jan 11 2022)

🚀 Enhancement

• fixing to_datacite: more flexible for urls #107 (@djarecka @satra)

🐛 Bug Fix

• Add dandi:dandi-zarr-checksum digest #108 (@dchiquito @satra)
• fix: raise validation error on mismatched name #97 (@satra)
• fix: allows aggregation after discarding path extensions #105 (@satra)
• fix: address pydantic issue to make value required #106 (@satra)
• Update versioningit version #103 (@jwodder)

🏠 Internal

• Remove duplicate "requests" dependency #101 (@jwodder)
• Update codecov action to v2 #95 (@jwodder)

🧪 Tests

• Test against Python 3.10 #99 (@jwodder)

Authors: 4

• Daniel Chiquito (@dchiquito)
• Dorota Jarecka (@djarecka)
• John T. Wodder II (@jwodder)
• Satrajit Ghosh (@satra)

---

0.4.3 (Thu Oct 07 2021)

🐛 Bug Fix

• enh: add subject and sample aggregating for bids dandisets #92 (@satra)

Authors: 1

• Satrajit Ghosh (@satra)

---

0.4.2 (Mon Oct 04 2021)

🐛 Bug Fix

• fix: associate schema key with schemas for older versions #91 (@satra @yarikoptic)

Authors: 2

• Satrajit Ghosh (@satra)
• Yaroslav Halchenko (@yarikoptic)

---

0.4.1 (Tue Sep 28 2021)

🐛 Bug Fix

• Better exception classes #89 (@dchiquito)

🧪 Tests

• Mark tests requiring network access and add a test workflow that disables network access #88 (@jwodder)

Authors: 2

• Daniel Chiquito (@dchiquito)
• John T. Wodder II (@jwodder)

---

0.4.0 (Sun Sep 26 2021)

🚀 Enhancement

• Release 0.6.0 #86 (@satra)

🐛 Bug Fix

• adds all properties to context with implicit dandi schema #84 (@satra)
• make schemaKey required and improve validation and migration functions #77 (@satra @yarikoptic)
• [fix] creating identifier from url in relatedResource #78 (@djarecka @satra)

Authors: 3

• Dorota Jarecka (@djarecka)
• Satrajit Ghosh (@satra)
• Yaroslav Halchenko (@yarikoptic)

---

0.3.4 (Wed Sep 15 2021)

🐛 Bug Fix

• remove NC license #83 (@satra)

Authors: 1

• Satrajit Ghosh (@satra)

---

0.3.3 (Thu Sep 09 2021)

🐛 Bug Fix

• fixing to_datacie, allowing for None in roleName #81 (@djarecka)

🏠 Internal

• Switch to versioningit (non-src-layout) #56 (@jwodder)

Authors: 2

• Dorota Jarecka (@djarecka)
• John T. Wodder II (@jwodder)

---

0.3.2 (Thu Jul 29 2021)

🐛 Bug Fix

• Datacite publish argument #70 (@dchiquito)

Authors: 1

• Daniel Chiquito (@dchiquito)

---

0.3.1 (Wed Jul 28 2021)

🐛 Bug Fix

• ensure schemaKeys are set properly #68 (@satra)

Authors: 1

• Satrajit Ghosh (@satra)

---

0.3.0 (Wed Jul 28 2021)

🚀 Enhancement

• improve help options #60 (@satra)
• Copy dandietag code from dandi-cli #58 (@jwodder)
• fix: clean up optional components of the schema #52 (@satra)

🐛 Bug Fix

• Use a generic DOI site instead of 10.80507 #65 (@dchiquito @satra)

⚠️ Pushed to master

• BF: do not refer to dandi-cli for LICENSE file (@yarikoptic)

🧪 Tests

• Set DANDI_ALLOW_LOCALHOST_URLS when running dandi-cli tests #66 (@jwodder)
• RF(CI): run dandi-cli tests only against 3.8 (but all OSes) #64 (@yarikoptic)
• Run dandi-cli tests with dandi-api image built with local version of dandischema #63 (@jwodder)
• fix: change id to identifier for software #46 (@satra)
• Add workflow for testing dandischema against latest release of dandi-cli #49 (@jwodder)

Authors: 4

• Daniel Chiquito (@dchiquito)
• John T. Wodder II (@jwodder)
• Satrajit Ghosh (@satra)
• Yaroslav Halchenko (@yarikoptic)

---

0.2.10 (Wed Jun 30 2021)

🐛 Bug Fix

• enh: allow checking to see data are matched but allow for missing fields #48 (@satra)
• adding AgeReferenceType #50 (@djarecka)

Authors: 2

• Dorota Jarecka (@djarecka)
• Satrajit Ghosh (@satra)

---

0.2.9 (Thu Jun 24 2021)

🐛 Bug Fix

• doc: add a bit more info to readme #45 (@satra)
• release.yml: Use DANDI_GITHUB_TOKEN to push to repo #44 (@jwodder)
• enh: update models to do more validation checks #42 (@satra)

🏠 Internal

• Add flake8 to .pre-commit-config.taml #39 (@jwodder)

Authors: 2

• John T. Wodder II (@jwodder)
• Satrajit Ghosh (@satra)

---

0.2.8 (Fri Jun 18 2021)

🐛 Bug Fix

• Fix: Make the library more robust for publishing #41 (@satra)

Authors: 1

• Satrajit Ghosh (@satra)

---

0.2.7 (Thu Jun 17 2021)

🐛 Bug Fix

• fix: allow migration for versions greater than 0.3.2 #40 (@satra @yarikoptic)

Authors: 2

• Satrajit Ghosh (@satra)
• Yaroslav Halchenko (@yarikoptic)

---

0.2.6 (Wed Jun 16 2021)

🐛 Bug Fix

• fix: make assetsummary computable for dandisets with no assets #38 (@satra @dchiquito)

Authors: 2

• Daniel Chiquito (@dchiquito)
• Satrajit Ghosh (@satra)

---

0.2.5 (Wed Jun 16 2021)

🐛 Bug Fix

• enh: implement metadata aggregator for asset summary #34 (@satra @yarikoptic)
• Only attempt to remove contributorType if present #37 (@dchiquito)

Authors: 3

• Daniel Chiquito (@dchiquito)
• Satrajit Ghosh (@satra)
• Yaroslav Halchenko (@yarikoptic)

---

0.2.4 (Thu Jun 10 2021)

🐛 Bug Fix

• Allow location fields to have localhost URLs #33 (@dchiquito)

Authors: 1

• Daniel Chiquito (@dchiquito)

---

0.2.3 (Wed Jun 09 2021)

🐛 Bug Fix

• fix: update migration code to account for missing fields #30 (@satra)

🏠 Internal

• Use DANDI_GITHUB_TOKEN to check out dandi/schema when releasing #31 (@jwodder)

Authors: 2

• John T. Wodder II (@jwodder)
• Satrajit Ghosh (@satra)

---

0.2.2 (Tue Jun 08 2021)

🐛 Bug Fix

• fix: remove readOnly from constants #28 (@satra)

Authors: 1

• Satrajit Ghosh (@satra)

---

0.2.1 (Fri May 28 2021)

🐛 Bug Fix

• fix: dandi-etag carries extra component beyond md5 #24 (@satra)

🏠 Internal

• Add missing "working-directory" #27 (@jwodder)
• Delete schema-* tags before running auto #26 (@jwodder)
• Fix release workflow #25 (@jwodder)
• Patch versioneer to exclude tags that don't start with a digit #20 (@jwodder)

🧪 Tests

• Set up schema testing and autorelease of new schemata #17 (@jwodder)

Authors: 2

• John T. Wodder II (@jwodder)
• Satrajit Ghosh (@satra)

---

0.2.1 (Fri May 28 2021)

🐛 Bug Fix

• fix: dandi-etag carries extra component beyond md5 #24 (@satra)

🏠 Internal

• Fix release workflow #25 (@jwodder)
• Patch versioneer to exclude tags that don't start with a digit #20 (@jwodder)

🧪 Tests

• Set up schema testing and autorelease of new schemata #17 (@jwodder)

Authors: 2

• John T. Wodder II (@jwodder)
• Satrajit Ghosh (@satra)

---

0.2.0 (Wed May 26 2021)

🚀 Enhancement

• ENH: support migration, validation, schema improvements #6 (@satra @yarikoptic)

🐛 Bug Fix

• Fix/schemakey metaclass #13 (@yarikoptic)

Authors: 2

• Satrajit Ghosh (@satra)
• Yaroslav Halchenko (@yarikoptic)

---

0.1.1 (Tue May 25 2021)

🏠 Internal

• RF(TEMP): disable publishing new versions of schemata #11 (@yarikoptic)
• Pin auto version #10 (@jwodder)
• Include CHANGELOG.md and tox.ini in sdists #8 (@jwodder)

📝 Documentation

• Start CHANGELOG #1 (@jwodder)

Authors: 2

• John T. Wodder II (@jwodder)
• Yaroslav Halchenko (@yarikoptic)

---

0.1.0 (2021-05-20)

Initial release (after splitting code off from dandi)