Merge pull request #201 from zmx27/setup-CI

skpkg: setup CI after migrating tests, src, requirements, and .github folder

Author: sbillinge

.github/workflows/tests-on-pr.yml

@@ -1,15 +1,12 @@
 name: Tests on PR
 
 on:
-  push:
-    branches:
-      - main
   pull_request:
   workflow_dispatch:
 
 jobs:
   tests-on-pr:
-    uses: Billingegroup/release-scripts/.github/workflows/_tests-on-pr.yml@v0
+    uses: scikit-package/release-scripts/.github/workflows/_tests-on-pr.yml@v0
     with:
       project: diffpy.morph
       c_extension: false

.gitignore

@@ -10,6 +10,7 @@ __pycache__/
 .Python
 env/
 build/
+_build/
 develop-eggs/
 dist/
 downloads/
@@ -90,10 +91,3 @@ target/
 
 # Ipython Notebook
 .ipynb_checkpoints
-
-# version information
-setup.cfg
-/src/diffpy/*/version.cfg
-
-# Rever
-rever/

.pre-commit-config.yaml

@@ -50,3 +50,17 @@ repos:
       - id: codespell
         additional_dependencies:
           - tomli
+  # prettier - multi formatter for .json, .yml, and .md files
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: f12edd9c7be1c20cfa42420fd0e6df71e42b51ea # frozen: v4.0.0-alpha.8
+    hooks:
+      - id: prettier
+        additional_dependencies:
+          - "prettier@^3.2.4"
+  # docformatter - PEP 257 compliant docstring formatter
+  - repo: https://github.com/s-weigand/docformatter
+    rev: 5757c5190d95e5449f102ace83df92e7d3b06c6c
+    hooks:
+      - id: docformatter
+        additional_dependencies: [tomli]
+        args: [--in-place, --config, ./pyproject.toml]

requirements/build.txt

@@ -1,4 +1,5 @@
 sphinx
 sphinx_rtd_theme
+sphinx-copybutton
 doctr
 m2r

requirements/docs.txt

@@ -2,5 +2,5 @@ flake8
 pytest
 codecov
 coverage
-pytest-env
 pytest-cov
+pytest-env

requirements/test.txt

@@ -1,19 +1,18 @@
 #!/usr/bin/env python
 ##############################################################################
 #
-# (c) 2024 The Trustees of Columbia University in the City of New York.
+# (c) 2025 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.pdfmorph/graphs/contributors
+# https://github.com/diffpy/diffpy.morph/graphs/contributors
 #
 # See LICENSE.rst for license information.
 #
 ##############################################################################
 """morph - tools for manipulating and comparing PDF data.
-
 """
 
 

src/diffpy/__init__.py

@@ -1,27 +1,26 @@
 #!/usr/bin/env python
 ##############################################################################
 #
-# (c) 2024 The Trustees of Columbia University in the City of New York.
+# (c) 2025 The Trustees of Columbia University in the City of New York.
 # All rights reserved.
 #
-# File coded by: Billinge Group members and community contributors.
+# File coded by: Sangjoon Lee, Simon Billinge, Billinge Group members.
 #
 # See GitHub contributions for a more detailed list of contributors.
 # https://github.com/diffpy/diffpy.morph/graphs/contributors
 #
 # See LICENSE.rst for license information.
 #
 ##############################################################################
-"""Tools for manipulating and comparing PDF profiles."""
+"""Python package for manipulating and comparing PDF profiles."""
 
 # key used when saving multiple morphs
 __save_morph_as__ = "save_morph_as"
 
 # package version
-from diffpy.morph.version import __version__
+from diffpy.morph.version import __version__  # noqa
 
 # silence the pyflakes syntax checker
 assert __version__ or True
 
-
 # End of file

src/diffpy/morph/__init__.py

@@ -1,13 +1,13 @@
 #!/usr/bin/env python
 ##############################################################################
 #
-# (c) 2024 The Trustees of Columbia University in the City of New York.
+# (c) 2025 The Trustees of Columbia University in the City of New York.
 # All rights reserved.
 #
-# File coded by: Billinge Group members and community contributors.
+# File coded by: Sangjoon Lee, Simon Billinge, Billinge Group members.
 #
 # See GitHub contributions for a more detailed list of contributors.
-# https://github.com/diffpy/diffpy.pdfmorph/graphs/contributors
+# https://github.com/diffpy/diffpy.morph/graphs/contributors  # noqa: E501
 #
 # See LICENSE.rst for license information.
 #

src/diffpy/morph/version.py

@@ -1,6 +1,6 @@
 """Unit tests for __version__.py."""
 
-import diffpy.morph
+import diffpy.morph  # noqa
 
 
 def test_package_version():