README.rst

@@ -27,6 +27,28 @@ Install
 Usage
 -----
 
+Read Surface File
+~~~~~~~~~~~~~~~~~
+
+.. code:: python
+
+    from freesurfer_surface import Surface
+
+    surface = Surface.read_triangular('bert/surf/lh.pial')
+
+    for vertex in surface.vertices[:3]:
+        print(vertex)
+
+    vertex_0 = surface.vertices[0]
+    print('coordinates of vertex #0:', (vertex_0.right, vertex_0.anterior, vertex_0.superior))
+
+    for triangle_index, triangle in enumerate(surface.triangles[:4]):
+        print('\ntriangle #{}:'.format(triangle_index))
+        print('vertex indices:', triangle.vertex_indices)
+        print('vertex coordinates:')
+        for vertex in surface.select_vertices(triangle.vertex_indices):
+            print((vertex.right, vertex.anterior, vertex.superior))
+
 Edit Surface File
 ~~~~~~~~~~~~~~~~~
 

freesurfer_surface/__init__.py

@@ -48,7 +48,11 @@ import typing
 
 import numpy
 
-from freesurfer_surface.version import __version__
+try:
+    from freesurfer_surface.version import __version__
+except ImportError:  # ModuleNotFoundError not available in python<3.6
+    # package is not installed
+    __version__ = None
 
 
 class UnsupportedLocaleSettingError(locale.Error):

tests/test_version.py

@@ -0,0 +1,40 @@
+import re
+import pathlib
+import subprocess
+import sys
+
+import pytest
+
+import freesurfer_surface
+
+_VERSION_MODULE_PATH = pathlib.Path(__file__).parent.parent.joinpath(
+    "freesurfer_surface", "version.py"
+)
+
+
+def test_version():
+    if not _VERSION_MODULE_PATH.exists():
+        pytest.skip("package is not installed")
+    assert re.match(r"^\d+\.\d+\.\d+", freesurfer_surface.__version__)
+
+
+def test_version_missing(tmp_path):
+    temp_module_path = tmp_path.joinpath("version.py")
+    if _VERSION_MODULE_PATH.exists():
+        _VERSION_MODULE_PATH.rename(temp_module_path)
+    try:
+        assert (
+            subprocess.run(
+                [
+                    sys.executable,
+                    "-c",
+                    "import freesurfer_surface; print(freesurfer_surface.__version__)",
+                ],
+                check=True,
+                stdout=subprocess.PIPE,
+            ).stdout.rstrip()
+            == b"None"
+        )
+    finally:
+        if temp_module_path.exists():
+            temp_module_path.rename(_VERSION_MODULE_PATH)