Merge pull request #47 from SciCatProject/scicat_object_structure

Added examples of SciCat dataset and origdatablocks schema

Author: nitrosx

MANIFEST.in

@@ -0,0 +1,2 @@
+include src/scicat_schemas/dataset.schema.json.jinja
+include src/scicat_schemas/origdatablock.schema.json.jinja

pyproject.toml

@@ -32,6 +32,7 @@ dependencies = [
   "ess-streaming-data-types",
   "graypy",
   "h5py",
+  "jinja2",
   "kafka-python",
   "requests",
   "rich"

requirements/base.in

@@ -2,9 +2,11 @@
 # will not be touched by ``make_base.py``
 # --- END OF CUSTOM SECTION ---
 # The following was generated by 'tox -e deps', DO NOT EDIT MANUALLY!
-kafka-python
 confluent_kafka
 ess-streaming-data-types
+graypy
+h5py
+jinja2
+kafka-python
 requests
 rich
-graypy

requirements/base.txt

@@ -1,35 +1,45 @@
-# SHA1:bad3be485e41242eafd3a41c6ed2b021210bd026
+# SHA1:0432d8fc729bb08876212fbb1777a15f2b2ab3e2
 #
 # This file is autogenerated by pip-compile-multi
 # To update, run:
 #
 #    pip-compile-multi
 #
-certifi==2024.6.2
+certifi==2024.7.4
     # via requests
 charset-normalizer==3.3.2
     # via requests
-confluent-kafka==2.4.0
+confluent-kafka==2.5.0
     # via -r base.in
 ess-streaming-data-types==0.26.1
     # via -r base.in
 flatbuffers==24.3.25
     # via ess-streaming-data-types
+graypy==2.1.0
+    # via -r base.in
+h5py==3.11.0
+    # via -r base.in
 idna==3.7
     # via requests
+jinja2==3.1.4
+    # via -r base.in
 kafka-python==2.0.2
     # via -r base.in
 markdown-it-py==3.0.0
     # via rich
+markupsafe==2.1.5
+    # via jinja2
 mdurl==0.1.2
     # via markdown-it-py
-numpy==1.26.4
-    # via ess-streaming-data-types
+numpy==2.0.0
+    # via
+    #   ess-streaming-data-types
+    #   h5py
 pygments==2.18.0
     # via rich
 requests==2.32.3
     # via -r base.in
 rich==13.7.1
     # via -r base.in
-urllib3==2.2.1
+urllib3==2.2.2
     # via requests

requirements/basetest.txt

@@ -5,15 +5,11 @@
 #
 #    pip-compile-multi
 #
-exceptiongroup==1.2.1
-    # via pytest
 iniconfig==2.0.0
     # via pytest
-packaging==24.0
+packaging==24.1
     # via pytest
 pluggy==1.5.0
     # via pytest
-pytest==8.2.1
+pytest==8.2.2
     # via -r basetest.in
-tomli==2.0.1
-    # via pytest

requirements/ci.txt

@@ -5,23 +5,23 @@
 #
 #    pip-compile-multi
 #
-cachetools==5.3.3
+cachetools==5.4.0
     # via tox
 chardet==5.2.0
     # via tox
 colorama==0.4.6
     # via tox
 distlib==0.3.8
     # via virtualenv
-filelock==3.14.0
+filelock==3.15.4
     # via
     #   tox
     #   virtualenv
 gitdb==4.0.11
     # via gitpython
 gitpython==3.1.43
     # via -r ci.in
-packaging==24.0
+packaging==24.1
     # via
     #   -r ci.in
     #   pyproject-api
@@ -32,15 +32,11 @@ platformdirs==4.2.2
     #   virtualenv
 pluggy==1.5.0
     # via tox
-pyproject-api==1.6.1
+pyproject-api==1.7.1
     # via tox
 smmap==5.0.1
     # via gitdb
-tomli==2.0.1
-    # via
-    #   pyproject-api
-    #   tox
-tox==4.15.0
+tox==4.16.0
     # via -r ci.in
-virtualenv==20.26.2
+virtualenv==20.26.3
     # via tox

requirements/dev.txt

@@ -18,33 +18,27 @@ click==8.1.7
     # via
     #   pip-compile-multi
     #   pip-tools
-copier==9.2.0
+copier==9.3.1
     # via -r dev.in
-dunamai==1.21.1
+dunamai==1.21.2
     # via copier
 funcy==2.0
     # via copier
-jinja2==3.1.4
-    # via
-    #   copier
-    #   jinja2-ansible-filters
 jinja2-ansible-filters==1.3.2
     # via copier
-markupsafe==2.1.5
-    # via jinja2
 pathspec==0.12.1
     # via copier
-pip-compile-multi==2.6.3
+pip-compile-multi==2.6.4
     # via -r dev.in
 pip-tools==7.4.1
     # via pip-compile-multi
 plumbum==1.8.3
     # via copier
 prompt-toolkit==3.0.36
     # via questionary
-pydantic==2.7.2
+pydantic==2.8.2
     # via copier
-pydantic-core==2.18.3
+pydantic-core==2.20.1
     # via pydantic
 pyproject-hooks==1.1.0
     # via

requirements/mypy.txt

@@ -6,9 +6,9 @@
 #    pip-compile-multi
 #
 -r test.txt
-mypy==1.10.0
+mypy==1.10.1
     # via -r mypy.in
 mypy-extensions==1.0.0
     # via mypy
-typing-extensions==4.12.1
+typing-extensions==4.12.2
     # via mypy

requirements/nightly.in

@@ -1,9 +1,11 @@
 -r basetest.in
 # --- END OF CUSTOM SECTION ---
 # The following was generated by 'tox -e deps', DO NOT EDIT MANUALLY!
-kafka-python
 confluent_kafka
 ess-streaming-data-types
+graypy
+h5py
+jinja2
+kafka-python
 requests
 rich
-graypy

requirements/nightly.txt

@@ -1,36 +1,46 @@
-# SHA1:d6bc96251e6b13b5797a6bae33485ff077b19b5f
+# SHA1:be3092a4379377d5f1bf7cb4731a0d81e621362d
 #
 # This file is autogenerated by pip-compile-multi
 # To update, run:
 #
 #    pip-compile-multi
 #
 -r basetest.txt
-certifi==2024.6.2
+certifi==2024.7.4
     # via requests
 charset-normalizer==3.3.2
     # via requests
-confluent-kafka==2.4.0
+confluent-kafka==2.5.0
     # via -r nightly.in
 ess-streaming-data-types==0.26.1
     # via -r nightly.in
 flatbuffers==24.3.25
     # via ess-streaming-data-types
+graypy==2.1.0
+    # via -r nightly.in
+h5py==3.11.0
+    # via -r nightly.in
 idna==3.7
     # via requests
+jinja2==3.1.4
+    # via -r nightly.in
 kafka-python==2.0.2
     # via -r nightly.in
 markdown-it-py==3.0.0
     # via rich
+markupsafe==2.1.5
+    # via jinja2
 mdurl==0.1.2
     # via markdown-it-py
-numpy==1.26.4
-    # via ess-streaming-data-types
+numpy==2.0.0
+    # via
+    #   ess-streaming-data-types
+    #   h5py
 pygments==2.18.0
     # via rich
 requests==2.32.3
     # via -r nightly.in
 rich==13.7.1
     # via -r nightly.in
-urllib3==2.2.1
+urllib3==2.2.2
     # via requests

requirements/static.txt

@@ -9,17 +9,17 @@ cfgv==3.4.0
     # via pre-commit
 distlib==0.3.8
     # via virtualenv
-filelock==3.14.0
+filelock==3.15.4
     # via virtualenv
-identify==2.5.36
+identify==2.6.0
     # via pre-commit
-nodeenv==1.9.0
+nodeenv==1.9.1
     # via pre-commit
 platformdirs==4.2.2
     # via virtualenv
 pre-commit==3.7.1
     # via -r static.in
 pyyaml==6.0.1
     # via pre-commit
-virtualenv==20.26.2
+virtualenv==20.26.3
     # via pre-commit

resources/coda.imsc.json.example

@@ -101,7 +101,7 @@
     "proposal_id": {
       "field_type": "high_level",
       "machine_name": "proposalId",
-      "value": "proposal_id",
+      "value": "<proposal_id>",
       "type": "string",
     },
     "dataset_name": {