Add version flag to wkcuber (#471)

* add version flag to wkcuber

* update changelogs

* create version file after publishing

Author: rschwanhold

publish.sh

@@ -20,6 +20,8 @@ for PKG in */pyproject.toml; do
     sed -i 's/\(.*\) = .* path \= \"\.\..*/\1 = "'"$PKG_VERSION"'"/g' pyproject.toml
     poetry publish --build -u "$PYPI_USERNAME" -p "$PYPI_PASSWORD"
 
+    echo "__version__ = '$PKG_VERSION'" > ./"$PKG"/version.py
+
     # Restore files
     mv pyproject.toml.bak pyproject.toml
 

webknossos/.gitignore

@@ -104,3 +104,5 @@ ENV/
 
 # MyPy
 .mypy_cache/
+
+/webknossos/version.py

webknossos/Changelog.md

@@ -6,11 +6,9 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/) `MAJOR.MINOR.PATCH`.
 For upgrade instructions, please check the respective *Breaking Changes* sections.
 
-
 ## Unreleased
 [Commits](https://github.com/scalableminds/webknossos-cuber/compare/v0.8.22...HEAD)
 
-
 ### Breaking Changes
 ### Added
 ### Changed
@@ -23,6 +21,11 @@ For upgrade instructions, please check the respective *Breaking Changes* section
 ### Breaking Changes
 - Removed the `organization` parameter from the `webknossos_context` function. The organization will automatically be fetched using the token of the user. [#470](https://github.com/scalableminds/webknossos-libs/pull/470)
 
+### Fixed
+- Make Views picklable. We now ignore the file handle when we pickle Views. [#469](https://github.com/scalableminds/webknossos-libs/pull/469)
+
+## [v0.8.19](https://github.com/scalableminds/webknossos-cuber/releases/tag/v0.8.19) - 2021-10-21
+[Commits](https://github.com/scalableminds/webknossos-libs/compare/v0.8.18...v.8.19)
 ### Added
 - Added a `User` class to the client that can be used to get meta-information of users or their logged time. The currently logged in user can be accessed, as well as all managed users. [#470](https://github.com/scalableminds/webknossos-libs/pull/470)
 

wkcuber/.gitignore

@@ -108,3 +108,5 @@ testdata/tiff_mag_2_reference
 .mypy_cache/
 
 /poetry.toml
+
+/wkcuber/version.py

wkcuber/Changelog.md

@@ -7,15 +7,19 @@ and this project adheres to [Semantic Versioning](http://semver.org/) `MAJOR.MIN
 For upgrade instructions, please check the respective *Breaking Changes* sections.
 
 ## Unreleased
-[Commits](https://github.com/scalableminds/webknossos-libs/compare/v0.8.19...HEAD)
+[Commits](https://github.com/scalableminds/webknossos-libs/compare/v0.8.20...HEAD)
 
 ### Breaking Changes in Config & CLI
 ### Added
+- Added the flag `--version` to `wkcuber`. [#471](https://github.com/scalableminds/webknossos-libs/pull/471)
 ### Changed
 ### Fixed
 
-## [0.8.19](https://github.com/scalableminds/webknossos-cuber/releases/tag/v0.8.19) - 2021-10-21
-[Commits](https://github.com/scalableminds/webknossos-cuber/compare/v0.8.18...v0.8.19)
+## [v0.8.20](https://github.com/scalableminds/webknossos-cuber/releases/tag/v0.8.20) - 2021-10-28
+[Commits](https://github.com/scalableminds/webknossos-libs/compare/v0.8.19...v.8.20)
+
+## [v0.8.19](https://github.com/scalableminds/webknossos-cuber/releases/tag/v0.8.19) - 2021-10-21
+[Commits](https://github.com/scalableminds/webknossos-libs/compare/v0.8.18...v.8.19)
 
 ### Fixed
 - Fixed two bugs in `cubing` (regarding `start_z` and `pad`). As a result, the ImageConverters do no longer cache metadata. [#460](https://github.com/scalableminds/webknossos-libs/pull/460)

wkcuber/poetry.lock

@@ -24,6 +24,7 @@ czifile = "^2019.7.2"
 attrs = "^21.1.0"
 cattrs = "1.7.1"
 webknossos = { path = "../webknossos/", develop = true }
+GitPython = "^3.0.5"
 
 [tool.poetry.dev-dependencies]
 black = "^20.8b1"

wkcuber/pyproject.toml

@@ -0,0 +1,25 @@
+def get_git_version() -> str:
+    import git
+
+    git_hash = git.Repo(search_parent_directories=True).head.object.hexsha
+    return git_hash
+
+
+def get_package_version() -> str:
+    # pylint: disable=no-name-in-module,import-error
+    from wkcuber.version import __version__
+
+    return __version__
+
+
+def get_available_version() -> str:
+    """
+    If the current code lies in the published package, a version.py file will exist which was created at
+    publish-time. That version info is returned here.
+    Otherwise, the version is derived using the git repository in which the code lives.
+    """
+
+    try:
+        return get_package_version()
+    except ModuleNotFoundError:
+        return get_git_version()

wkcuber/versioning.py

@@ -1,5 +1,6 @@
 from typing import List, Dict
 
+from versioning import get_available_version
 from wkcuber import downsample_mags
 from .compress import compress_mag_inplace
 from .metadata import refresh_metadata
@@ -58,6 +59,10 @@ def create_parser() -> ArgumentParser:
         action="store_true",
     )
 
+    parser.add_argument(
+        "--version", action="version", version=f"wkcuber {get_available_version()}"
+    )
+
     parser.add_argument("--name", "-n", help="Name of the dataset", default=None)
     add_isotropic_flag(parser)
     add_sampling_mode_flag(parser)