aind-data-access-api 1.9.2__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.2 → aind_data_access_api-1.9.4}/PKG-INFO +1 -1
  2. {aind_data_access_api-1.9.2 → aind_data_access_api-1.9.4}/docs/source/ExamplesDocDBRestApi.rst +9 -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.2 → aind_data_access_api-1.9.4}/src/aind_data_access_api/document_db.py +53 -5
  5. {aind_data_access_api-1.9.2 → aind_data_access_api-1.9.4}/src/aind_data_access_api.egg-info/PKG-INFO +1 -1
  6. aind_data_access_api-1.9.2/src/aind_data_access_api/__init__.py +0 -3
  7. {aind_data_access_api-1.9.2 → aind_data_access_api-1.9.4}/.flake8 +0 -0
  8. {aind_data_access_api-1.9.2 → aind_data_access_api-1.9.4}/.github/ISSUE_TEMPLATE/bug_report.md +0 -0
  9. {aind_data_access_api-1.9.2 → aind_data_access_api-1.9.4}/.github/ISSUE_TEMPLATE/feature_request.md +0 -0
  10. {aind_data_access_api-1.9.2 → aind_data_access_api-1.9.4}/.github/ISSUE_TEMPLATE/user-story.md +0 -0
  11. {aind_data_access_api-1.9.2 → aind_data_access_api-1.9.4}/.github/workflows/add_issue_to_project_board.yml +0 -0
  12. {aind_data_access_api-1.9.2 → aind_data_access_api-1.9.4}/.github/workflows/publish_main.yml +0 -0
  13. {aind_data_access_api-1.9.2 → aind_data_access_api-1.9.4}/.github/workflows/run_dev_tests.yml +0 -0
  14. {aind_data_access_api-1.9.2 → aind_data_access_api-1.9.4}/.github/workflows/run_main_tests.yml +0 -0
  15. {aind_data_access_api-1.9.2 → aind_data_access_api-1.9.4}/.gitignore +0 -0
  16. {aind_data_access_api-1.9.2 → aind_data_access_api-1.9.4}/.readthedocs.yaml +0 -0
  17. {aind_data_access_api-1.9.2 → aind_data_access_api-1.9.4}/CODE_OF_CONDUCT.md +0 -0
  18. {aind_data_access_api-1.9.2 → aind_data_access_api-1.9.4}/LICENSE +0 -0
  19. {aind_data_access_api-1.9.2 → aind_data_access_api-1.9.4}/README.md +0 -0
  20. {aind_data_access_api-1.9.2 → aind_data_access_api-1.9.4}/docs/Makefile +0 -0
  21. {aind_data_access_api-1.9.2 → aind_data_access_api-1.9.4}/docs/make.bat +0 -0
  22. {aind_data_access_api-1.9.2 → aind_data_access_api-1.9.4}/docs/source/Contributing.rst +0 -0
  23. {aind_data_access_api-1.9.2 → aind_data_access_api-1.9.4}/docs/source/ExamplesDocDBDirectConnection.rst +0 -0
  24. {aind_data_access_api-1.9.2 → aind_data_access_api-1.9.4}/docs/source/Helpers.rst +0 -0
  25. {aind_data_access_api-1.9.2 → aind_data_access_api-1.9.4}/docs/source/UserGuide.rst +0 -0
  26. {aind_data_access_api-1.9.2 → aind_data_access_api-1.9.4}/docs/source/_static/dark-logo.svg +0 -0
  27. {aind_data_access_api-1.9.2 → aind_data_access_api-1.9.4}/docs/source/_static/favicon.ico +0 -0
  28. {aind_data_access_api-1.9.2 → aind_data_access_api-1.9.4}/docs/source/_static/light-logo.svg +0 -0
  29. {aind_data_access_api-1.9.2 → aind_data_access_api-1.9.4}/docs/source/aind_data_access_api.helpers.rst +0 -0
  30. {aind_data_access_api-1.9.2 → aind_data_access_api-1.9.4}/docs/source/aind_data_access_api.rst +0 -0
  31. {aind_data_access_api-1.9.2 → aind_data_access_api-1.9.4}/docs/source/conf.py +0 -0
  32. {aind_data_access_api-1.9.2 → aind_data_access_api-1.9.4}/docs/source/index.rst +0 -0
  33. {aind_data_access_api-1.9.2 → aind_data_access_api-1.9.4}/docs/source/modules.rst +0 -0
  34. {aind_data_access_api-1.9.2 → aind_data_access_api-1.9.4}/pyproject.toml +0 -0
  35. {aind_data_access_api-1.9.2 → aind_data_access_api-1.9.4}/setup.cfg +0 -0
  36. {aind_data_access_api-1.9.2 → aind_data_access_api-1.9.4}/setup.py +0 -0
  37. {aind_data_access_api-1.9.2 → aind_data_access_api-1.9.4}/src/aind_data_access_api/credentials.py +0 -0
  38. {aind_data_access_api-1.9.2 → 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.2 → aind_data_access_api-1.9.4}/src/aind_data_access_api/helpers/__init__.py +0 -0
  40. {aind_data_access_api-1.9.2 → 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.2 → aind_data_access_api-1.9.4}/src/aind_data_access_api/helpers/docdb.py +0 -0
  42. {aind_data_access_api-1.9.2 → aind_data_access_api-1.9.4}/src/aind_data_access_api/rds_tables.py +0 -0
  43. {aind_data_access_api-1.9.2 → aind_data_access_api-1.9.4}/src/aind_data_access_api/secrets.py +0 -0
  44. {aind_data_access_api-1.9.2 → aind_data_access_api-1.9.4}/src/aind_data_access_api/utils.py +0 -0
  45. {aind_data_access_api-1.9.2 → 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.2 → 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.2 → 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.2 → 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.2 → aind_data_access_api-1.9.4}/tests/__init__.py +0 -0
  50. {aind_data_access_api-1.9.2 → aind_data_access_api-1.9.4}/tests/helpers/__init__.py +0 -0
  51. {aind_data_access_api-1.9.2 → aind_data_access_api-1.9.4}/tests/helpers/test_data_schema.py +0 -0
  52. {aind_data_access_api-1.9.2 → aind_data_access_api-1.9.4}/tests/helpers/test_docdb.py +0 -0
  53. {aind_data_access_api-1.9.2 → aind_data_access_api-1.9.4}/tests/resources/helpers/quality_control.json +0 -0
  54. {aind_data_access_api-1.9.2 → aind_data_access_api-1.9.4}/tests/resources/helpers/quality_control_invalid.json +0 -0
  55. {aind_data_access_api-1.9.2 → aind_data_access_api-1.9.4}/tests/resources/utils/example_metadata.nd.json +0 -0
  56. {aind_data_access_api-1.9.2 → aind_data_access_api-1.9.4}/tests/resources/utils/example_metadata1.nd.json +0 -0
  57. {aind_data_access_api-1.9.2 → aind_data_access_api-1.9.4}/tests/resources/utils/example_metadata2.nd.json +0 -0
  58. {aind_data_access_api-1.9.2 → aind_data_access_api-1.9.4}/tests/test_credentials.py +0 -0
  59. {aind_data_access_api-1.9.2 → aind_data_access_api-1.9.4}/tests/test_document_db.py +0 -0
  60. {aind_data_access_api-1.9.2 → aind_data_access_api-1.9.4}/tests/test_document_db_ssh.py +0 -0
  61. {aind_data_access_api-1.9.2 → aind_data_access_api-1.9.4}/tests/test_rds_tables.py +0 -0
  62. {aind_data_access_api-1.9.2 → aind_data_access_api-1.9.4}/tests/test_secrets_access.py +0 -0
  63. {aind_data_access_api-1.9.2 → 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.2
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,8 +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
- 1. **Permissions**: Request permissions for AWS Credentials to write to DocDB through the API Gateway.
203
+ 1. **Permissions**: Request permissions for AWS Credentials to write to DocDB through the API Gateway.
204
+ Note that the asset de/registration endpoints are intended for administrative use and require elevated AWS credentials/permissions.
197
205
  2. **Query DocDB**: Filter for the records you want to update.
198
206
  3. **Update DocDB**: Use ``upsert_one_docdb_record`` or ``upsert_list_of_docdb_records`` to update the records.
199
207
 
@@ -0,0 +1,3 @@
1
+ """Init package"""
2
+
3
+ __version__ = "1.9.4"
@@ -631,7 +631,9 @@ class MetadataDbClient(Client):
631
631
  return f"https://{self.host}/{self.version}/add_qc_evaluation"
632
632
 
633
633
  def generate_data_summary(self, record_id: str) -> Dict[str, Any]:
634
- """Get an LLM-generated summary for a data asset."""
634
+ """
635
+ Get an LLM-generated summary for a data asset with the given record id.
636
+ """
635
637
  url = f"{self._data_summary_url}/{record_id}"
636
638
  signed_header = self._signed_request(method="GET", url=url)
637
639
  response = self.session.get(
@@ -641,8 +643,21 @@ class MetadataDbClient(Client):
641
643
  return response.json()
642
644
 
643
645
  def register_asset(self, s3_location: str) -> Dict[str, Any]:
644
- """Register a data asset to Code Ocean and the DocDB metadata index."""
646
+ """
647
+ Register a data asset to Code Ocean and add its metadata to DocDB
648
+ given the metadata exists at the top level of the provided S3 location.
649
+
650
+ Parameters
651
+ ----------
652
+ s3_location : str
653
+ The S3 location containing the asset and its metadata.
645
654
 
655
+ Returns
656
+ -------
657
+ Dict[str, Any]
658
+ The response from the registration API, including registration
659
+ status and details.
660
+ """
646
661
  data = json.dumps({"s3_location": s3_location})
647
662
  signed_header = self._signed_request(
648
663
  method="POST", url=self._register_asset_url, data=data
@@ -662,8 +677,28 @@ class MetadataDbClient(Client):
662
677
  co_asset_id: str,
663
678
  co_computation_id: str,
664
679
  ) -> Dict[str, Any]:
665
- """Register a Code Ocean result asset to the DocDB metadata index."""
680
+ """
681
+ Register a Code Ocean result asset and add its metadata to DocDB
682
+ given the metadata exists at the top level of the Code Ocean
683
+ computation result.
666
684
 
685
+ Parameters
686
+ ----------
687
+ s3_location : str
688
+ The S3 location containing the result asset and its metadata.
689
+ name : str
690
+ The name of the result asset.
691
+ co_asset_id : str
692
+ The Code Ocean asset ID for the result.
693
+ co_computation_id : str
694
+ The Code Ocean computation ID associated with the result.
695
+
696
+ Returns
697
+ -------
698
+ Dict[str, Any]
699
+ The response from the registration API, including registration
700
+ status and details.
701
+ """
667
702
  data = json.dumps(
668
703
  {
669
704
  "s3_location": s3_location,
@@ -684,9 +719,22 @@ class MetadataDbClient(Client):
684
719
  return response.json()
685
720
 
686
721
  def deregister_asset(self, s3_location: str) -> Dict[str, Any]:
687
- """De-register (delete) a data asset in Code Ocean and the
688
- DocDB metadata index."""
722
+ """
723
+ De-register (delete) a data asset from Code Ocean and remove its
724
+ metadata from DocDB given that the asset and its metadata are located
725
+ at the provided S3 location.
689
726
 
727
+ Parameters
728
+ ----------
729
+ s3_location : str
730
+ The S3 location containing the asset and metadata to be removed.
731
+
732
+ Returns
733
+ -------
734
+ Dict[str, Any]
735
+ The response from the deregistration API, including deregistration
736
+ status and details.
737
+ """
690
738
  data = json.dumps({"s3_location": s3_location})
691
739
  signed_header = self._signed_request(
692
740
  method="DELETE", url=self._deregister_asset_url, data=data
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: aind-data-access-api
3
- Version: 1.9.2
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.2"