aind-data-access-api 1.9.3__tar.gz → 1.9.4__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (63) hide show
  1. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/PKG-INFO +1 -1
  2. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/docs/source/ExamplesDocDBRestApi.rst +8 -1
  3. aind_data_access_api-1.9.4/src/aind_data_access_api/__init__.py +3 -0
  4. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/src/aind_data_access_api.egg-info/PKG-INFO +1 -1
  5. aind_data_access_api-1.9.3/src/aind_data_access_api/__init__.py +0 -3
  6. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/.flake8 +0 -0
  7. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/.github/ISSUE_TEMPLATE/bug_report.md +0 -0
  8. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/.github/ISSUE_TEMPLATE/feature_request.md +0 -0
  9. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/.github/ISSUE_TEMPLATE/user-story.md +0 -0
  10. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/.github/workflows/add_issue_to_project_board.yml +0 -0
  11. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/.github/workflows/publish_main.yml +0 -0
  12. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/.github/workflows/run_dev_tests.yml +0 -0
  13. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/.github/workflows/run_main_tests.yml +0 -0
  14. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/.gitignore +0 -0
  15. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/.readthedocs.yaml +0 -0
  16. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/CODE_OF_CONDUCT.md +0 -0
  17. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/LICENSE +0 -0
  18. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/README.md +0 -0
  19. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/docs/Makefile +0 -0
  20. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/docs/make.bat +0 -0
  21. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/docs/source/Contributing.rst +0 -0
  22. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/docs/source/ExamplesDocDBDirectConnection.rst +0 -0
  23. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/docs/source/Helpers.rst +0 -0
  24. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/docs/source/UserGuide.rst +0 -0
  25. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/docs/source/_static/dark-logo.svg +0 -0
  26. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/docs/source/_static/favicon.ico +0 -0
  27. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/docs/source/_static/light-logo.svg +0 -0
  28. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/docs/source/aind_data_access_api.helpers.rst +0 -0
  29. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/docs/source/aind_data_access_api.rst +0 -0
  30. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/docs/source/conf.py +0 -0
  31. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/docs/source/index.rst +0 -0
  32. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/docs/source/modules.rst +0 -0
  33. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/pyproject.toml +0 -0
  34. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/setup.cfg +0 -0
  35. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/setup.py +0 -0
  36. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/src/aind_data_access_api/credentials.py +0 -0
  37. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/src/aind_data_access_api/document_db.py +0 -0
  38. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/src/aind_data_access_api/document_db_ssh.py +0 -0
  39. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/src/aind_data_access_api/helpers/__init__.py +0 -0
  40. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/src/aind_data_access_api/helpers/data_schema.py +0 -0
  41. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/src/aind_data_access_api/helpers/docdb.py +0 -0
  42. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/src/aind_data_access_api/rds_tables.py +0 -0
  43. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/src/aind_data_access_api/secrets.py +0 -0
  44. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/src/aind_data_access_api/utils.py +0 -0
  45. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/src/aind_data_access_api.egg-info/SOURCES.txt +0 -0
  46. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/src/aind_data_access_api.egg-info/dependency_links.txt +0 -0
  47. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/src/aind_data_access_api.egg-info/requires.txt +0 -0
  48. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/src/aind_data_access_api.egg-info/top_level.txt +0 -0
  49. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/tests/__init__.py +0 -0
  50. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/tests/helpers/__init__.py +0 -0
  51. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/tests/helpers/test_data_schema.py +0 -0
  52. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/tests/helpers/test_docdb.py +0 -0
  53. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/tests/resources/helpers/quality_control.json +0 -0
  54. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/tests/resources/helpers/quality_control_invalid.json +0 -0
  55. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/tests/resources/utils/example_metadata.nd.json +0 -0
  56. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/tests/resources/utils/example_metadata1.nd.json +0 -0
  57. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/tests/resources/utils/example_metadata2.nd.json +0 -0
  58. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/tests/test_credentials.py +0 -0
  59. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/tests/test_document_db.py +0 -0
  60. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/tests/test_document_db_ssh.py +0 -0
  61. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/tests/test_rds_tables.py +0 -0
  62. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/tests/test_secrets_access.py +0 -0
  63. {aind_data_access_api-1.9.3 → aind_data_access_api-1.9.4}/tests/test_utils.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: aind-data-access-api
3
- Version: 1.9.3
3
+ Version: 1.9.4
4
4
  Summary: API to interact with a few AIND databases
5
5
  Author: Allen Institute for Neural Dynamics
6
6
  License: MIT
@@ -192,9 +192,16 @@ It's possible to attach a custom Session to retry certain requests errors:
192
192
 
193
193
  Updating Metadata
194
194
  ~~~~~~~~~~~~~~~~~~~~~~
195
+ .. note::
196
+
197
+ Manual updates to metadata in DocDB should be made through the
198
+ `aind-data-migration-scripts <https://github.com/AllenNeuralDynamics/aind-data-migration-scripts>`_
199
+ repository to track changes. Please see the README in that repository for instructions.
200
+
201
+ For special use cases, a minimal example of updating metadata directly using the API is provided below.
195
202
 
196
203
  1. **Permissions**: Request permissions for AWS Credentials to write to DocDB through the API Gateway.
197
- Note that the asset de/registration endpoints are intended for administrative use and require elevated AWS credentials/permissions.
204
+ Note that the asset de/registration endpoints are intended for administrative use and require elevated AWS credentials/permissions.
198
205
  2. **Query DocDB**: Filter for the records you want to update.
199
206
  3. **Update DocDB**: Use ``upsert_one_docdb_record`` or ``upsert_list_of_docdb_records`` to update the records.
200
207
 
@@ -0,0 +1,3 @@
1
+ """Init package"""
2
+
3
+ __version__ = "1.9.4"
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: aind-data-access-api
3
- Version: 1.9.3
3
+ Version: 1.9.4
4
4
  Summary: API to interact with a few AIND databases
5
5
  Author: Allen Institute for Neural Dynamics
6
6
  License: MIT
@@ -1,3 +0,0 @@
1
- """Init package"""
2
-
3
- __version__ = "1.9.3"