entitysdk 0.3.2__tar.gz → 0.5.0__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 (118) hide show
  1. {entitysdk-0.3.2/src/entitysdk.egg-info → entitysdk-0.5.0}/PKG-INFO +3 -4
  2. {entitysdk-0.3.2 → entitysdk-0.5.0}/README.md +2 -3
  3. {entitysdk-0.3.2 → entitysdk-0.5.0}/examples/01_searching.ipynb +18 -9
  4. entitysdk-0.5.0/examples/02_morphology.ipynb +640 -0
  5. {entitysdk-0.3.2 → entitysdk-0.5.0}/examples/03_contribution.ipynb +7 -6
  6. entitysdk-0.5.0/examples/04_circuit.ipynb +168 -0
  7. entitysdk-0.5.0/examples/05_simulation_campaign.ipynb +164 -0
  8. {entitysdk-0.3.2 → entitysdk-0.5.0}/src/entitysdk/client.py +18 -62
  9. entitysdk-0.5.0/src/entitysdk/downloaders/__init__.py +1 -0
  10. entitysdk-0.5.0/src/entitysdk/downloaders/emodel.py +29 -0
  11. entitysdk-0.5.0/src/entitysdk/downloaders/ion_channel_model.py +29 -0
  12. entitysdk-0.5.0/src/entitysdk/downloaders/memodel.py +42 -0
  13. entitysdk-0.5.0/src/entitysdk/downloaders/morphology.py +36 -0
  14. {entitysdk-0.3.2 → entitysdk-0.5.0}/src/entitysdk/models/__init__.py +8 -0
  15. entitysdk-0.5.0/src/entitysdk/models/circuit.py +23 -0
  16. entitysdk-0.5.0/src/entitysdk/models/scientific_artifact.py +22 -0
  17. entitysdk-0.5.0/src/entitysdk/models/simulation.py +12 -0
  18. entitysdk-0.5.0/src/entitysdk/models/simulation_campaign.py +11 -0
  19. {entitysdk-0.3.2 → entitysdk-0.5.0}/src/entitysdk/route.py +4 -0
  20. entitysdk-0.5.0/src/entitysdk/schemas/memodel.py +13 -0
  21. entitysdk-0.5.0/src/entitysdk/token_manager.py +56 -0
  22. entitysdk-0.5.0/src/entitysdk/types.py +107 -0
  23. entitysdk-0.5.0/src/entitysdk/utils/filesystem.py +12 -0
  24. {entitysdk-0.3.2 → entitysdk-0.5.0/src/entitysdk.egg-info}/PKG-INFO +3 -4
  25. {entitysdk-0.3.2 → entitysdk-0.5.0}/src/entitysdk.egg-info/SOURCES.txt +23 -1
  26. {entitysdk-0.3.2 → entitysdk-0.5.0}/tests/unit/conftest.py +2 -2
  27. entitysdk-0.5.0/tests/unit/downloaders/test_emodel.py +70 -0
  28. entitysdk-0.5.0/tests/unit/downloaders/test_ion_channel_model.py +72 -0
  29. entitysdk-0.5.0/tests/unit/downloaders/test_memodel.py +199 -0
  30. entitysdk-0.5.0/tests/unit/downloaders/test_morphology.py +68 -0
  31. entitysdk-0.5.0/tests/unit/models/data/circuit.json +84 -0
  32. entitysdk-0.5.0/tests/unit/models/data/simulation_campaign.json +134 -0
  33. entitysdk-0.5.0/tests/unit/models/test_circuit.py +38 -0
  34. {entitysdk-0.3.2 → entitysdk-0.5.0}/tests/unit/models/test_electrical_cell_recording.py +1 -2
  35. {entitysdk-0.3.2 → entitysdk-0.5.0}/tests/unit/models/test_ion_channel_model.py +1 -3
  36. {entitysdk-0.3.2 → entitysdk-0.5.0}/tests/unit/models/test_memodel_calibration_result.py +1 -2
  37. {entitysdk-0.3.2 → entitysdk-0.5.0}/tests/unit/models/test_morphology.py +1 -3
  38. entitysdk-0.5.0/tests/unit/models/test_simulation_campaign.py +40 -0
  39. {entitysdk-0.3.2 → entitysdk-0.5.0}/tests/unit/models/test_validation_result.py +1 -2
  40. {entitysdk-0.3.2 → entitysdk-0.5.0}/tests/unit/test_client.py +8 -50
  41. {entitysdk-0.3.2 → entitysdk-0.5.0}/tests/unit/test_token_manager.py +10 -0
  42. entitysdk-0.5.0/tests/unit/utils/test_filesystem.py +6 -0
  43. entitysdk-0.3.2/examples/02_morphology.ipynb +0 -470
  44. entitysdk-0.3.2/src/entitysdk/token_manager.py +0 -30
  45. entitysdk-0.3.2/src/entitysdk/types.py +0 -67
  46. {entitysdk-0.3.2 → entitysdk-0.5.0}/.github/workflows/sdist.yml +0 -0
  47. {entitysdk-0.3.2 → entitysdk-0.5.0}/.github/workflows/tox.yml +0 -0
  48. {entitysdk-0.3.2 → entitysdk-0.5.0}/.gitignore +0 -0
  49. {entitysdk-0.3.2 → entitysdk-0.5.0}/CHANGELOG.rst +0 -0
  50. {entitysdk-0.3.2 → entitysdk-0.5.0}/CONTRIBUTING.md +0 -0
  51. {entitysdk-0.3.2 → entitysdk-0.5.0}/LICENSE.txt +0 -0
  52. {entitysdk-0.3.2 → entitysdk-0.5.0}/pyproject.toml +0 -0
  53. {entitysdk-0.3.2 → entitysdk-0.5.0}/setup.cfg +0 -0
  54. {entitysdk-0.3.2 → entitysdk-0.5.0}/src/entitysdk/__init__.py +0 -0
  55. {entitysdk-0.3.2 → entitysdk-0.5.0}/src/entitysdk/common.py +0 -0
  56. {entitysdk-0.3.2 → entitysdk-0.5.0}/src/entitysdk/config.py +0 -0
  57. {entitysdk-0.3.2 → entitysdk-0.5.0}/src/entitysdk/core.py +0 -0
  58. {entitysdk-0.3.2 → entitysdk-0.5.0}/src/entitysdk/exception.py +0 -0
  59. {entitysdk-0.3.2 → entitysdk-0.5.0}/src/entitysdk/mixin.py +0 -0
  60. {entitysdk-0.3.2 → entitysdk-0.5.0}/src/entitysdk/models/agent.py +0 -0
  61. {entitysdk-0.3.2 → entitysdk-0.5.0}/src/entitysdk/models/asset.py +0 -0
  62. {entitysdk-0.3.2 → entitysdk-0.5.0}/src/entitysdk/models/base.py +0 -0
  63. {entitysdk-0.3.2 → entitysdk-0.5.0}/src/entitysdk/models/brain_location.py +0 -0
  64. {entitysdk-0.3.2 → entitysdk-0.5.0}/src/entitysdk/models/brain_region.py +0 -0
  65. {entitysdk-0.3.2 → entitysdk-0.5.0}/src/entitysdk/models/contribution.py +0 -0
  66. {entitysdk-0.3.2 → entitysdk-0.5.0}/src/entitysdk/models/core.py +0 -0
  67. {entitysdk-0.3.2 → entitysdk-0.5.0}/src/entitysdk/models/electrical_cell_recording.py +0 -0
  68. {entitysdk-0.3.2 → entitysdk-0.5.0}/src/entitysdk/models/emodel.py +0 -0
  69. {entitysdk-0.3.2 → entitysdk-0.5.0}/src/entitysdk/models/entity.py +0 -0
  70. {entitysdk-0.3.2 → entitysdk-0.5.0}/src/entitysdk/models/etype.py +0 -0
  71. {entitysdk-0.3.2 → entitysdk-0.5.0}/src/entitysdk/models/ion_channel_model.py +0 -0
  72. {entitysdk-0.3.2 → entitysdk-0.5.0}/src/entitysdk/models/license.py +0 -0
  73. {entitysdk-0.3.2 → entitysdk-0.5.0}/src/entitysdk/models/memodel.py +0 -0
  74. {entitysdk-0.3.2 → entitysdk-0.5.0}/src/entitysdk/models/memodelcalibrationresult.py +0 -0
  75. {entitysdk-0.3.2 → entitysdk-0.5.0}/src/entitysdk/models/morphology.py +0 -0
  76. {entitysdk-0.3.2 → entitysdk-0.5.0}/src/entitysdk/models/mtype.py +0 -0
  77. {entitysdk-0.3.2 → entitysdk-0.5.0}/src/entitysdk/models/response.py +0 -0
  78. {entitysdk-0.3.2 → entitysdk-0.5.0}/src/entitysdk/models/subject.py +0 -0
  79. {entitysdk-0.3.2 → entitysdk-0.5.0}/src/entitysdk/models/taxonomy.py +0 -0
  80. {entitysdk-0.3.2 → entitysdk-0.5.0}/src/entitysdk/models/validation_result.py +0 -0
  81. {entitysdk-0.3.2 → entitysdk-0.5.0}/src/entitysdk/result.py +0 -0
  82. {entitysdk-0.3.2 → entitysdk-0.5.0}/src/entitysdk/schemas/__init__.py +0 -0
  83. {entitysdk-0.3.2 → entitysdk-0.5.0}/src/entitysdk/schemas/asset.py +0 -0
  84. {entitysdk-0.3.2 → entitysdk-0.5.0}/src/entitysdk/schemas/base.py +0 -0
  85. {entitysdk-0.3.2 → entitysdk-0.5.0}/src/entitysdk/serdes.py +0 -0
  86. {entitysdk-0.3.2 → entitysdk-0.5.0}/src/entitysdk/util.py +0 -0
  87. {entitysdk-0.3.2 → entitysdk-0.5.0}/src/entitysdk/utils/__init__.py +0 -0
  88. {entitysdk-0.3.2 → entitysdk-0.5.0}/src/entitysdk/utils/asset.py +0 -0
  89. {entitysdk-0.3.2 → entitysdk-0.5.0}/src/entitysdk.egg-info/dependency_links.txt +0 -0
  90. {entitysdk-0.3.2 → entitysdk-0.5.0}/src/entitysdk.egg-info/requires.txt +0 -0
  91. {entitysdk-0.3.2 → entitysdk-0.5.0}/src/entitysdk.egg-info/top_level.txt +0 -0
  92. {entitysdk-0.3.2 → entitysdk-0.5.0}/tests/__init__.py +0 -0
  93. {entitysdk-0.3.2 → entitysdk-0.5.0}/tests/integration/__init__.py +0 -0
  94. {entitysdk-0.3.2 → entitysdk-0.5.0}/tests/integration/conftest.py +0 -0
  95. {entitysdk-0.3.2 → entitysdk-0.5.0}/tests/integration/test_searching.py +0 -0
  96. {entitysdk-0.3.2 → entitysdk-0.5.0}/tests/unit/__init__.py +0 -0
  97. {entitysdk-0.3.2 → entitysdk-0.5.0}/tests/unit/models/__init__.py +0 -0
  98. {entitysdk-0.3.2 → entitysdk-0.5.0}/tests/unit/models/data/.gitignore +0 -0
  99. {entitysdk-0.3.2 → entitysdk-0.5.0}/tests/unit/models/data/electrical_cell_recording.json +0 -0
  100. {entitysdk-0.3.2 → entitysdk-0.5.0}/tests/unit/models/data/ion_channel_model.json +0 -0
  101. {entitysdk-0.3.2 → entitysdk-0.5.0}/tests/unit/models/data/memodel_calibration_result.json +0 -0
  102. {entitysdk-0.3.2 → entitysdk-0.5.0}/tests/unit/models/data/reconstruction_morphology.json +0 -0
  103. {entitysdk-0.3.2 → entitysdk-0.5.0}/tests/unit/models/data/validation_result.json +0 -0
  104. {entitysdk-0.3.2 → entitysdk-0.5.0}/tests/unit/models/test_agent.py +0 -0
  105. {entitysdk-0.3.2 → entitysdk-0.5.0}/tests/unit/models/test_asset.py +0 -0
  106. {entitysdk-0.3.2 → entitysdk-0.5.0}/tests/unit/models/test_brain_region.py +0 -0
  107. {entitysdk-0.3.2 → entitysdk-0.5.0}/tests/unit/models/test_contribution.py +0 -0
  108. {entitysdk-0.3.2 → entitysdk-0.5.0}/tests/unit/models/test_init.py +0 -0
  109. {entitysdk-0.3.2 → entitysdk-0.5.0}/tests/unit/test_base.py +0 -0
  110. {entitysdk-0.3.2 → entitysdk-0.5.0}/tests/unit/test_common.py +0 -0
  111. {entitysdk-0.3.2 → entitysdk-0.5.0}/tests/unit/test_config.py +0 -0
  112. {entitysdk-0.3.2 → entitysdk-0.5.0}/tests/unit/test_result.py +0 -0
  113. {entitysdk-0.3.2 → entitysdk-0.5.0}/tests/unit/test_route.py +0 -0
  114. {entitysdk-0.3.2 → entitysdk-0.5.0}/tests/unit/test_serdes.py +0 -0
  115. {entitysdk-0.3.2 → entitysdk-0.5.0}/tests/unit/test_util.py +0 -0
  116. {entitysdk-0.3.2 → entitysdk-0.5.0}/tests/unit/util.py +0 -0
  117. {entitysdk-0.3.2 → entitysdk-0.5.0}/tests/unit/utils/test_asset.py +0 -0
  118. {entitysdk-0.3.2 → entitysdk-0.5.0}/tox.ini +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: entitysdk
3
- Version: 0.3.2
3
+ Version: 0.5.0
4
4
  Summary: Python library for interacting with the entitycore service
5
5
  Author-email: Open Brain Institute <info@openbraininstitute.org>
6
6
  Maintainer-email: Open Brain Institute <info@openbraininstitute.org>
@@ -66,14 +66,14 @@ client = Client(
66
66
  project_id=UUID("your-project-id"),
67
67
  virtual_lab_id=UUID("your-lab-id")
68
68
  ),
69
- environment="staging"
69
+ environment="staging",
70
+ token_manager=token
70
71
  )
71
72
 
72
73
  # Search for morphologies
73
74
  iterator = client.search_entity(
74
75
  entity_type=models.ReconstructionMorphology,
75
76
  query={"mtype__pref_label": "L5_TPC:A"},
76
- token=token,
77
77
  limit=1,
78
78
  )
79
79
  morphology = next(iterator)
@@ -84,7 +84,6 @@ client.upload_file(
84
84
  entity_type=models.ReconstructionMorphology,
85
85
  file_path="path/to/file.swc",
86
86
  file_content_type="application/swc",
87
- token="your-token"
88
87
  )
89
88
  ```
90
89
 
@@ -45,14 +45,14 @@ client = Client(
45
45
  project_id=UUID("your-project-id"),
46
46
  virtual_lab_id=UUID("your-lab-id")
47
47
  ),
48
- environment="staging"
48
+ environment="staging",
49
+ token_manager=token
49
50
  )
50
51
 
51
52
  # Search for morphologies
52
53
  iterator = client.search_entity(
53
54
  entity_type=models.ReconstructionMorphology,
54
55
  query={"mtype__pref_label": "L5_TPC:A"},
55
- token=token,
56
56
  limit=1,
57
57
  )
58
58
  morphology = next(iterator)
@@ -63,7 +63,6 @@ client.upload_file(
63
63
  entity_type=models.ReconstructionMorphology,
64
64
  file_path="path/to/file.swc",
65
65
  file_content_type="application/swc",
66
- token="your-token"
67
66
  )
68
67
  ```
69
68
 
@@ -28,8 +28,9 @@
28
28
  " virtual_lab_id=\"a98b7abc-fc46-4700-9e3d-37137812c730\",\n",
29
29
  " project_id=\"0dbced5f-cc3d-488a-8c7f-cfb8ea039dc6\",\n",
30
30
  ")\n",
31
- "client = Client(api_url=entitycore_api_url, project_context=project_context)\n",
32
31
  "token = os.getenv(\"ACCESS_TOKEN\", \"XXX\")\n",
32
+ "client = Client(api_url=entitycore_api_url, project_context=project_context, token_manager=token)\n",
33
+ "\n",
33
34
  "\n",
34
35
  "# uncomment for staging\n",
35
36
  "# from obi_auth import get_token\n",
@@ -53,7 +54,7 @@
53
54
  "metadata": {},
54
55
  "outputs": [],
55
56
  "source": [
56
- "all_species = client.search_entity(entity_type=Species, token=token).all()"
57
+ "all_species = client.search_entity(entity_type=Species).all()"
57
58
  ]
58
59
  },
59
60
  {
@@ -82,7 +83,7 @@
82
83
  "metadata": {},
83
84
  "outputs": [],
84
85
  "source": [
85
- "all_strains = client.search_entity(entity_type=Strain, token=token).all()"
86
+ "all_strains = client.search_entity(entity_type=Strain).all()"
86
87
  ]
87
88
  },
88
89
  {
@@ -111,7 +112,7 @@
111
112
  "metadata": {},
112
113
  "outputs": [],
113
114
  "source": [
114
- "all_roles = client.search_entity(entity_type=Role, token=token).all()"
115
+ "all_roles = client.search_entity(entity_type=Role).all()"
115
116
  ]
116
117
  },
117
118
  {
@@ -140,7 +141,7 @@
140
141
  "metadata": {},
141
142
  "outputs": [],
142
143
  "source": [
143
- "all_users = client.search_entity(entity_type=Person, token=token).all()"
144
+ "all_users = client.search_entity(entity_type=Person).all()"
144
145
  ]
145
146
  },
146
147
  {
@@ -169,7 +170,7 @@
169
170
  "metadata": {},
170
171
  "outputs": [],
171
172
  "source": [
172
- "all_orgs = client.search_entity(entity_type=Organization, token=token).all()"
173
+ "all_orgs = client.search_entity(entity_type=Organization).all()"
173
174
  ]
174
175
  },
175
176
  {
@@ -198,7 +199,7 @@
198
199
  "metadata": {},
199
200
  "outputs": [],
200
201
  "source": [
201
- "all_mtypes = client.search_entity(entity_type=MTypeClass, token=token).all()"
202
+ "all_mtypes = client.search_entity(entity_type=MTypeClass).all()"
202
203
  ]
203
204
  },
204
205
  {
@@ -227,7 +228,7 @@
227
228
  "metadata": {},
228
229
  "outputs": [],
229
230
  "source": [
230
- "morphs = client.search_entity(entity_type=ReconstructionMorphology, token=token, limit=10).all()"
231
+ "morphs = client.search_entity(entity_type=ReconstructionMorphology, limit=10).all()"
231
232
  ]
232
233
  },
233
234
  {
@@ -257,7 +258,7 @@
257
258
  "outputs": [],
258
259
  "source": [
259
260
  "morphs = client.search_entity(\n",
260
- " entity_type=ReconstructionMorphology, query={\"mtype__pref_label\": \"SR_PC\"}, token=token\n",
261
+ " entity_type=ReconstructionMorphology, query={\"mtype__pref_label\": \"SR_PC\"}\n",
261
262
  ").all()"
262
263
  ]
263
264
  },
@@ -271,6 +272,14 @@
271
272
  "rprint(len(morphs))\n",
272
273
  "rprint(morphs[:2])"
273
274
  ]
275
+ },
276
+ {
277
+ "cell_type": "code",
278
+ "execution_count": null,
279
+ "id": "4c41d5ae-81a6-4b01-965c-3f46a082cd31",
280
+ "metadata": {},
281
+ "outputs": [],
282
+ "source": []
274
283
  }
275
284
  ],
276
285
  "metadata": {