feat: minor improvements (#128)

Author: RobPasMue

doc/source/getting_started/installation.rst

@@ -4,17 +4,20 @@
 Install packages
 ================
 
-The ``ansys-sherlock`` package supports Python 3.7 through Python 3.10 on Windows.
+The ``ansys-sherlock-core`` package supports Python 3.7 through Python 3.10 on Windows.
 
 To use PySherlock, you must download and install both the ``ansys-api-sherlock``
-and ``ansys-sherlock`` packages.
+and ``ansys-sherlock-core`` packages. By using ``pip``, ``ansys-api-sherlock`` is
+installed as part of ``ansys-sherlock-core``. Run the following to install
 
-.. TODO: uncomment the following lines when PySherlock is released to the public PyPi.
-   Install the latest ``ansys-sherlock-core`` package from PyPi with:
+the publicly distributed version of the package.
 
-..   .. code::
+.. code::
 
-..   pip install ansys-sherlock-core
+   pip install ansys-sherlock-core
+
+If you want to install the ``ansys-api-sherlock`` and ``ansys-sherlock-core`` packages
+from its source code directly, follow the upcoming instructions:
 
 #. Download the latest ``ansys-api-sherlock`` package by running this
    ``git clone`` command:
@@ -35,7 +38,7 @@ and ``ansys-sherlock`` packages.
       cd ansys-api-sherlock
       pip install -e .
 
-#. Download the latest ``ansys-sherlock`` package by running this
+#. Download the latest ``ansys-sherlock-core`` package by running this
    ``git clone`` command:
 
    .. code::

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "flit_core.buildapi"
 
 [project]
 name = "ansys-sherlock-core"
-version = "0.1.dev0"
+version = "0.2.dev0"
 description = "A python wrapper for Ansys Sherlock"
 readme = "README.rst"
 requires-python = ">=3.8,<4"

src/ansys/sherlock/core/__init__.py

@@ -1,8 +1,22 @@
 # © 2023 ANSYS, Inc. All rights reserved.
 
 """PySherlock client library."""
-from ansys.sherlock.core._version import __version__
+
+# Version
+# ------------------------------------------------------------------------------
+
+try:
+    import importlib.metadata as importlib_metadata
+except ModuleNotFoundError:  # pragma: no cover
+    import importlib_metadata  # type: ignore
+
+__version__ = importlib_metadata.version(__name__.replace(".", "-"))
+"""PySherlock version."""
+
+# Ease import statements
+# ------------------------------------------------------------------------------
+
 from ansys.sherlock.core.logging import Logger
 
 LOG = Logger("sherlock")
-SHERLOCK = None
+"""PySherlock logger."""

src/ansys/sherlock/core/_version.py

@@ -0,0 +1,14 @@
+from ansys.sherlock.core import __version__
+
+
+def test_pkg_version():
+    try:
+        import importlib.metadata as importlib_metadata
+    except ModuleNotFoundError:  # pragma: no cover
+        import importlib_metadata
+
+    # Read from the pyproject.toml
+    # major, minor, patch
+    read_version = importlib_metadata.version("ansys-sherlock-core")
+
+    assert __version__ == read_version