refscan 0.3.3__tar.gz → 0.4.0__tar.gz

{refscan-0.3.3 → refscan-0.4.0}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.3
 Name: refscan
-Version: 0.3.3
+Version: 0.4.0
 Summary: Command-line program that scans the NMDC MongoDB database for referential integrity violations
 Keywords: mongodb,mongo,relationships,reference,database,data,referential integrity,scan
 Requires-Dist: linkml-runtime>=1.7.5,<2
 Requires-Dist: pymongo>=4.7.1,<5
 Requires-Dist: rich>=13.7.1,<14
 Requires-Dist: typer>=0.15.1,<0.16
-Requires-Python: >=3.9, <3.10
+Requires-Python: >=3.9, <4.0
 Project-URL: Documentation, https://github.com/microbiomedata/refscan
 Project-URL: Homepage, https://github.com/microbiomedata/refscan
 Project-URL: Repository, https://github.com/microbiomedata/refscan

{refscan-0.3.3 → refscan-0.4.0}/pyproject.toml

@@ -1,12 +1,9 @@
 [project]
 name = "refscan"
-version = "0.3.3"
+version = "0.4.0"
 description = "Command-line program that scans the NMDC MongoDB database for referential integrity violations"
 authors = []
-# Note: We constrain the Python version to 3.9.* because we know that `nmdc-schema`, which depends upon this
-#       package, is also constrained to Python 3.9.* (according to its `pyproject.toml` file).
-#       Reference: https://github.com/microbiomedata/nmdc-schema/blob/main/pyproject.toml#L34
-requires-python = ">= 3.9, < 3.10"
+requires-python = ">= 3.9, < 4.0"
 readme = "README.md"
 keywords = [
     "mongodb",

refscan-0.4.0/refscan/__init__.py

@@ -0,0 +1,23 @@
+from importlib.metadata import PackageNotFoundError, version
+from typing import Optional
+
+
+def get_package_version(package_name: str) -> Optional[str]:
+    r"""
+    Returns the version identifier (e.g., "1.2.3") of the package having the specified name.
+
+    Args:
+        package_name: The name of the package
+
+    Returns:
+        The version identifier of the package, or `None` if package not found
+    """
+    try:
+        return version(package_name)
+    except PackageNotFoundError:
+        return None
+
+
+# Make an `import`-able variable whose value is the version identifier of this package.
+app_name = "refscan"
+app_version = get_package_version(app_name)

{refscan-0.3.3 → refscan-0.4.0}/refscan/cli/scan.py

@@ -16,9 +16,7 @@ from refscan.lib.helpers import (
 )
 from refscan.lib.ViolationList import ViolationList
 from refscan.scanner import scan as refscan_scan
-from refscan import get_package_metadata
-
-app_version = get_package_metadata("Version")
+from refscan import app_version
 
 
 def scan(

{refscan-0.3.3 → refscan-0.4.0}/refscan/cli/version.py

@@ -1,9 +1,7 @@
 import typer
 
 from refscan.lib.constants import console
-from refscan import get_package_metadata
-
-app_version = get_package_metadata("Version")
+from refscan import app_version
 
 
 def version() -> None:

{refscan-0.3.3 → refscan-0.4.0}/refscan/grapher.py

@@ -6,7 +6,7 @@ from importlib import resources
 
 import linkml_runtime
 
-from refscan import get_package_metadata
+from refscan import app_version
 from refscan.lib.constants import console
 from refscan.lib.helpers import (
     get_collection_name_to_class_names_map,
@@ -161,7 +161,7 @@ def graph(
     graph_data_json_base64_str = encode_json_value_as_base64_str(elements)
     graph_metadata_json_base64_str = encode_json_value_as_base64_str(
         dict(
-            app_version=get_package_metadata("Version"),
+            app_version=app_version,
             schema_version=schema_view.schema.version,
             subject_singular="class" if subject == Subject.class_ else "collection",
             subject_plural="classes" if subject == Subject.class_ else "collections",

refscan-0.3.3/refscan/__init__.py

@@ -1,18 +0,0 @@
-from importlib.metadata import metadata, PackageNotFoundError
-
-
-def get_package_metadata(key: str) -> str:
-    r"""
-    Returns metadata about the installed package.
-
-    References:
-    - https://docs.python.org/3/library/importlib.metadata.html#distribution-metadata
-    - https://github.com/python-poetry/poetry/issues/273#issuecomment-570999678
-    """
-    metadata_value = ""
-    try:
-        package_metadata = metadata("refscan")
-        metadata_value = package_metadata.get(key, "")
-    except PackageNotFoundError:
-        pass
-    return metadata_value