diffpy and tests directories

Author: cadenmyers13

diffpy/__init__.py

@@ -0,0 +1,23 @@
+#!/usr/bin/env python
+##############################################################################
+#
+# (c) 2024 The Trustees of Columbia University in the City of New York.
+# All rights reserved.
+#
+# File coded by: Billinge Group members and community contributors.
+#
+# See GitHub contributions for a more detailed list of contributors.
+# https://github.com/diffpy/diffpy.fourigui/graphs/contributors
+#
+# See LICENSE.rst for license information.
+#
+##############################################################################
+
+"""Blank namespace package for module diffpy."""
+
+
+from pkgutil import extend_path
+
+__path__ = extend_path(__path__, __name__)
+
+# End of file

diffpy/fourigui/__init__.py

@@ -0,0 +1,24 @@
+#!/usr/bin/env python
+##############################################################################
+#
+# (c) 2024 The Trustees of Columbia University in the City of New York.
+# All rights reserved.
+#
+# File coded by: Billinge Group members and community contributors.
+#
+# See GitHub contributions for a more detailed list of contributors.
+# https://github.com/diffpy/diffpy.fourigui/graphs/contributors
+#
+# See LICENSE.rst for license information.
+#
+##############################################################################
+
+"""Tool for visualizing 3D diffraction and PDF Images."""
+
+# package version
+from diffpy.fourigui.version import __version__
+
+# silence the pyflakes syntax checker
+assert __version__ or True
+
+# End of file

diffpy/fourigui/tests/__init__.py

@@ -0,0 +1,19 @@
+import json
+from pathlib import Path
+
+import pytest
+
+
+@pytest.fixture
+def user_filesystem(tmp_path):
+    base_dir = Path(tmp_path)
+    home_dir = base_dir / "home_dir"
+    home_dir.mkdir(parents=True, exist_ok=True)
+    cwd_dir = base_dir / "cwd_dir"
+    cwd_dir.mkdir(parents=True, exist_ok=True)
+
+    home_config_data = {"username": "home_username", "email": "home@email.com"}
+    with open(home_dir / "diffpyconfig.json", "w") as f:
+        json.dump(home_config_data, f)
+
+    yield tmp_path

diffpy/fourigui/tests/conftest.py

@@ -0,0 +1,35 @@
+#!/usr/bin/env python
+##############################################################################
+#
+# (c) 2024 The Trustees of Columbia University in the City of New York.
+# All rights reserved.
+#
+# File coded by: Billinge Group members and community contributors.
+#
+# See GitHub contributions for a more detailed list of contributors.
+# https://github.com/diffpy/diffpy.fourigui/graphs/contributors
+#
+# See LICENSE.rst for license information.
+#
+##############################################################################
+
+"""
+Convenience module for debugging the unit tests using
+
+python -m diffpy.fourigui.tests.debug
+
+Exceptions raised by failed tests or other errors are not caught.
+"""
+
+
+if __name__ == "__main__":
+    import sys
+
+    from diffpy.fourigui.tests import testsuite
+
+    pattern = sys.argv[1] if len(sys.argv) > 1 else ""
+    suite = testsuite(pattern)
+    suite.debug()
+
+
+# End of file

diffpy/fourigui/tests/debug.py

@@ -0,0 +1,26 @@
+#!/usr/bin/env python
+##############################################################################
+#
+# (c) 2024 The Trustees of Columbia University in the City of New York.
+# All rights reserved.
+#
+# File coded by: Billinge Group members and community contributors.
+#
+# See GitHub contributions for a more detailed list of contributors.
+# https://github.com/diffpy/diffpy.fourigui/graphs/contributors
+#
+# See LICENSE.rst for license information.
+#
+##############################################################################
+
+"""Definition of __version__."""
+
+#  We do not use the other three variables, but can be added back if needed.
+#  __all__ = ["__date__", "__git_commit__", "__timestamp__", "__version__"]
+
+# obtain version information
+from importlib.metadata import version
+
+__version__ = version("diffpy.fourigui")
+
+# End of file

diffpy/fourigui/version.py

@@ -0,0 +1,19 @@
+import json
+from pathlib import Path
+
+import pytest
+
+
+@pytest.fixture
+def user_filesystem(tmp_path):
+    base_dir = Path(tmp_path)
+    home_dir = base_dir / "home_dir"
+    home_dir.mkdir(parents=True, exist_ok=True)
+    cwd_dir = base_dir / "cwd_dir"
+    cwd_dir.mkdir(parents=True, exist_ok=True)
+
+    home_config_data = {"username": "home_username", "email": "home@email.com"}
+    with open(home_dir / "diffpyconfig.json", "w") as f:
+        json.dump(home_config_data, f)
+
+    yield tmp_path

tests/conftest.py

@@ -0,0 +1,10 @@
+"""Unit tests for __version__.py
+"""
+
+import diffpy.fourigui
+
+
+def test_package_version():
+    """Ensure the package version is defined and not set to the initial placeholder."""
+    assert hasattr(diffpy.fourigui, "__version__")
+    assert diffpy.fourigui.__version__ != "0.0.0"