hatch-env-plus 0.1.0__py3-none-any.whl → 1.0.1__py3-none-any.whl

hatch_env_plus/plugin.py

@@ -4,13 +4,13 @@ from hatchling.version.source.plugin.interface import VersionSourceInterface
 
 
 class EnvironmentVariableVersionSource(VersionSourceInterface):
-    PLUGIN_NAME = 'env-plus'
+    PLUGIN_NAME = "env-plus"
 
     def get_version_data(self) -> dict:
-        variable = self.config.get('variable', 'PACKAGE_VERSION')
-        fallback = self.config.get('fallback', '0.0.0dev0')
-        version = os.environ.get(variable, fallback)
-        return {'version': version}
+        variable = self.config.get("variable", "PACKAGE_VERSION")
+        fallback = self.config.get("fallback", "0.0.0dev0") or None
+        version = os.environ.get(variable, None) or fallback
+        return {"version": version}
 
     def set_version(self, version: str, version_data: dict) -> None:
-        version_data['version'] = version
+        version_data["version"] = version

{hatch_env_plus-0.1.0.dist-info → hatch_env_plus-1.0.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hatch-env-plus
-Version: 0.1.0
+Version: 1.0.1
 Summary: A version source for Hatchling that reads the version from a given environment variable, but also allows for a fallback if the variable is not populated.
 Project-URL: homepage, https://github.com/jenskeiner/hatch_env_plus/
 Project-URL: repository, https://github.com/jenskeiner/hatch_env_plus.git
@@ -27,8 +27,9 @@ Description-Content-Type: text/markdown
 
 # Hatchling Environment Variable Version Source
 
-A Hatchling version source plugin that reads the version from an environment variable with a configurable fallback value,
-since the built-in environment variable version source does not allow to define a fallback.
+A [Hatchling](https://github.com/pypa/hatch) version source plugin that reads the version from an environment variable
+with a configurable fallback value, since the built-in [`env`](https://hatch.pypa.io/latest/plugins/version-source/env/)
+version source does not allow to define a fallback.
 
 ## Installation
 
@@ -57,13 +58,18 @@ Then, configure the version source:
 [tool.hatch.version]
 source = "env-plus"
 variable = "PACKAGE_VERSION"  # optional, default shown
-fallback = "0.0.0dev0"            # optional, default shown
+fallback = "0.0.0dev0"  # optional, default shown
 ```
 
-Use the `variable` field to set the environment variable to use and set `fallback` to the desired fallback version. 
+Use the `variable` field to set the environment variable to use, and set `fallback` to the desired fallback version.
 
-**Note: An empty version string is treated as undefined. Therefore, this will throw an error if the configured environment
-variable as well as the fallback are both empty.**
+**Note: An empty string, whether from the configured environment variable or from the fallback, is an
+undefined version.**
+
+If you explicitly set the configured environment variable to the empty string, your build will fail as no valid version
+is set. If you explicitly set `fallback` to an empty string, your build will fail when the configured environment
+variable is not set. This is the default behavior of [Hatchling]([Hatchling](https://github.com/pypa/hatch))'s built-in
+enviroment variable version source [`env`](https://hatch.pypa.io/latest/plugins/version-source/env/).
 
 ## Usage
 

hatch_env_plus-1.0.1.dist-info/RECORD

@@ -0,0 +1,8 @@
+hatch_env_plus/__init__.py,sha256=zJGQMEhazvvgCqxv453ca9YmaZf-nT8q78dfju1jNnI,101
+hatch_env_plus/hooks.py,sha256=5yc22VRzKOcVdAqHB-6UYOMBty1IUlgFSyTNOSJWtZc,185
+hatch_env_plus/plugin.py,sha256=GZ1PpuF-mNltkLZMZ9IpXj32XkpnX_HZg9Pl1yXt0iE,567
+hatch_env_plus-1.0.1.dist-info/METADATA,sha256=7_VedzpMPl12uMkLd-zBWOoDBr_WlDtHKCoW4w86rfk,3309
+hatch_env_plus-1.0.1.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+hatch_env_plus-1.0.1.dist-info/entry_points.txt,sha256=znfR_zsEJqQ4kew-3ZauRvfOFU1lrzMeZC4vshELYXY,40
+hatch_env_plus-1.0.1.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+hatch_env_plus-1.0.1.dist-info/RECORD,,

hatch_env_plus-0.1.0.dist-info/RECORD

@@ -1,8 +0,0 @@
-hatch_env_plus/__init__.py,sha256=zJGQMEhazvvgCqxv453ca9YmaZf-nT8q78dfju1jNnI,101
-hatch_env_plus/hooks.py,sha256=5yc22VRzKOcVdAqHB-6UYOMBty1IUlgFSyTNOSJWtZc,185
-hatch_env_plus/plugin.py,sha256=p7QfyI5D4IkenzjA64QmzRSObKX44vN3EIeYKXgnynE,551
-hatch_env_plus-0.1.0.dist-info/METADATA,sha256=3-2lBgA-uuq_foG906Q4bxkctdY9V4cSQq_NO-zL-ig,2835
-hatch_env_plus-0.1.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-hatch_env_plus-0.1.0.dist-info/entry_points.txt,sha256=znfR_zsEJqQ4kew-3ZauRvfOFU1lrzMeZC4vshELYXY,40
-hatch_env_plus-0.1.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-hatch_env_plus-0.1.0.dist-info/RECORD,,