Publish version as bluepysnap.__version__ (#212)

.gitignore

@@ -13,3 +13,4 @@ venv/
 .ipynb_checkpoints/
 .idea/
 .vscode
+bluepysnap/_version.py

CHANGELOG.rst

@@ -1,9 +1,13 @@
 Changelog
 =========
 
+Version v1.0.6
+--------------
+
 Improvements
 ~~~~~~~~~~~~
 - Clarification for partial circuit configs
+- Publish version as ``bluepysnap.__version__``
 
 Version v1.0.5
 --------------

bluepysnap/__init__.py

@@ -21,3 +21,8 @@
 from bluepysnap.config import Config
 from bluepysnap.exceptions import BluepySnapError
 from bluepysnap.simulation import Simulation
+
+try:
+    from bluepysnap._version import version as __version__
+except ImportError:  # pragma: no cover
+    __version__ = "unknown"

pyproject.toml

@@ -13,6 +13,10 @@ known_local_folder  =  [
 'test_module',
 ]
 
+[tool.pylint.main]
+# Files or directories to be skipped. They should be base names, not paths.
+ignore = ["CVS", "_version.py"]
+
 [tool.pylint.messages_control]
 disable = [
     'fixme',

setup.py

@@ -63,7 +63,9 @@ def __init__(self, *args, **kwargs):
     package_data={
         "bluepysnap": ["schemas/*.yaml", "schemas/*/*.yaml"],
     },
-    use_scm_version=True,
+    use_scm_version={
+        "write_to": "bluepysnap/_version.py",
+    },
     setup_requires=[
         "setuptools_scm",
     ],

tests/test_version.py

@@ -0,0 +1,9 @@
+import bluepysnap as test_module
+
+
+def test_version():
+    result = test_module.__version__
+
+    assert isinstance(result, str)
+    assert len(result) > 0
+    assert result[0].isdigit()