zen-temple 0.4.0.dev3__tar.gz → 0.4.2__tar.gz

{zen_temple-0.4.0.dev3/src/zen_temple.egg-info → zen_temple-0.4.2}/PKG-INFO

@@ -1,8 +1,8 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: zen_temple
-Version: 0.4.0.dev3
-Summary: The visualization plattform for ZEN Garden
-Author-email: Vinzenz Muser <muserv@ethz.ch>
+Version: 0.4.2
+Summary: The visualization plattform for ZEN-garden
+Author-email: ZEN-garden developers <zen-garden@ethz.ch>
 Project-URL: Homepage, https://github.com/ZEN-universe/ZEN-temple
 Project-URL: Issues, https://github.com/ZEN-universe/ZEN-temple/issues
 Classifier: Programming Language :: Python :: 3
@@ -17,6 +17,7 @@ Requires-Dist: fastapi-cache2
 Requires-Dist: python-dotenv
 Requires-Dist: zen-garden
 Requires-Dist: mypy>=1.14.1
+Dynamic: license-file
 
 # ZEN Temple
 ZEN Temple is a FastAPI Application.
@@ -37,7 +38,7 @@ Then, create a new copy of `.env`.
 cp .env.example .env
 ```
 
-Modify the `SOLUTION_FOLDER` variable to the location of your solutions. This is the `outputs` folder generated by ZEN garden. Look at the page [Running a model](https://zen-garden.readthedocs.io/en/latest/files/user_guide/running_models.html#run-zen-garden-with-preexisting-datasets) of the ZEN garden documentation.
+Modify the `SOLUTION_FOLDER` variable to the location of your solutions. This is the `outputs` folder generated by ZEN garden. Make sure that the path string uses `/` as a folder separator, and not `\`. Look at the page [Running a model](https://zen-garden.readthedocs.io/en/latest/files/user_guide/running_models.html#run-zen-garden-with-preexisting-datasets) of the ZEN garden documentation.
 
 ## Usage
 
@@ -48,6 +49,21 @@ conda activate <your-env-name>
 uvicorn src.zen_temple.main:app --reload
 ```
 
+## Release workflow
+
+To create a new release of ZEN-temple follow the following steps. The idea is that for each major release (from `v0.4.x` to `v0.5.0`) we sync the version number of ZEN explorer and ZEN temple
+
+1. Bump version in ZEN explorer `bash scripts/bump_version.sh` and update its CHANGELOG.md.
+2. Commit and upload the updated files to GitHub.
+3. Create a new release for ZEN explorer:
+https://github.com/ZEN-universe/ZEN-explorer/releases/new
+4. Bump version in ZEN temple `bash scripts/bump_version.sh` and update [CHANGELOG.md](CHANGELOG.md).
+5. Commit and upload the updated files to GitHub.
+6. Create a new release for ZEN temple, e.g. `<version>`. For a pre-release also add a suffix `.dev1`, i.e. `<version>.dev1`, and mark the release as pre-release:
+https://github.com/ZEN-universe/ZEN-temple/releases/new
+7. (optional) Look at PyPI whether the new release has successfully been created:
+https://pypi.org/project/zen-temple/#history
+
 ## Folder structure
 
 The folder and file structure is the following:

{zen_temple-0.4.0.dev3 → zen_temple-0.4.2}/README.md

@@ -17,7 +17,7 @@ Then, create a new copy of `.env`.
 cp .env.example .env
 ```
 
-Modify the `SOLUTION_FOLDER` variable to the location of your solutions. This is the `outputs` folder generated by ZEN garden. Look at the page [Running a model](https://zen-garden.readthedocs.io/en/latest/files/user_guide/running_models.html#run-zen-garden-with-preexisting-datasets) of the ZEN garden documentation.
+Modify the `SOLUTION_FOLDER` variable to the location of your solutions. This is the `outputs` folder generated by ZEN garden. Make sure that the path string uses `/` as a folder separator, and not `\`. Look at the page [Running a model](https://zen-garden.readthedocs.io/en/latest/files/user_guide/running_models.html#run-zen-garden-with-preexisting-datasets) of the ZEN garden documentation.
 
 ## Usage
 
@@ -28,6 +28,21 @@ conda activate <your-env-name>
 uvicorn src.zen_temple.main:app --reload
 ```
 
+## Release workflow
+
+To create a new release of ZEN-temple follow the following steps. The idea is that for each major release (from `v0.4.x` to `v0.5.0`) we sync the version number of ZEN explorer and ZEN temple
+
+1. Bump version in ZEN explorer `bash scripts/bump_version.sh` and update its CHANGELOG.md.
+2. Commit and upload the updated files to GitHub.
+3. Create a new release for ZEN explorer:
+https://github.com/ZEN-universe/ZEN-explorer/releases/new
+4. Bump version in ZEN temple `bash scripts/bump_version.sh` and update [CHANGELOG.md](CHANGELOG.md).
+5. Commit and upload the updated files to GitHub.
+6. Create a new release for ZEN temple, e.g. `<version>`. For a pre-release also add a suffix `.dev1`, i.e. `<version>.dev1`, and mark the release as pre-release:
+https://github.com/ZEN-universe/ZEN-temple/releases/new
+7. (optional) Look at PyPI whether the new release has successfully been created:
+https://pypi.org/project/zen-temple/#history
+
 ## Folder structure
 
 The folder and file structure is the following:

{zen_temple-0.4.0.dev3 → zen_temple-0.4.2}/pyproject.toml

@@ -4,11 +4,11 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "zen_temple"
-version = "0.4.0.dev3"
+version = "0.4.2"
 authors = [
-  { name="Vinzenz Muser", email="muserv@ethz.ch" },
+  { name="ZEN-garden developers", email="zen-garden@ethz.ch" },
 ]
-description = "The visualization plattform for ZEN Garden"
+description = "The visualization plattform for ZEN-garden"
 requires-python= ">=3.10"
 readme = "README.md"
 classifiers = [