initial commit of all the things for CI

Author: sbillinge

.codecov.yml

@@ -0,0 +1,34 @@
+# codecov can find this file anywhere in the repo, so we don't need to clutter
+# the root folder.
+#comment: false
+
+codecov:
+  notify:
+    require_ci_to_pass: no
+
+coverage:
+  status:
+    patch:
+      default:
+        target: '70'
+        if_no_uploads: error
+        if_not_found: success
+        if_ci_failed: failure
+    project:
+      default: false
+      library:
+        target: auto
+        if_no_uploads: error
+        if_not_found: success
+        if_ci_failed: failure
+        paths: '!*/tests/.*'
+
+      tests:
+        target: 97.9%
+        paths: '*/tests/.*'
+        if_not_found: success
+
+flags:
+  tests:
+    paths:
+      - tests/

.coveragerc

@@ -14,9 +14,18 @@ exclude_lines =
     ^[ ]*@unittest.skip\b
     ^[ ]{4}unittest.main()
     if __name__ == .__main__.:
+omit =
+    */python?.?/*
+    */site-packages/nose/*
+    # ignore _version.py and versioneer.py
+    .*version.*
+    *_version.py
 
 
 [run]
+source =
+    src/diffpy/utils/
 omit =
     ## exclude debug.py from codecov report
     */tests/debug.py
+

.github/workflows/main.yml

@@ -0,0 +1,54 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  miniconda:
+    name: Miniconda ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+        matrix:
+            os: ["ubuntu-latest"]
+    steps:
+      - name: check out diffpy.utils
+        uses: actions/checkout@v3
+        with:
+          repository: diffpy/diffpy.utils
+          path: .
+
+      - name: initialize miniconda
+        # this uses a marketplace action that sets up miniconda in a way that makes
+        # it easier to use.  I tried setting it up without this and it was a pain
+        uses: conda-incubator/setup-miniconda@v2
+        with:
+          activate-environment: test
+          # environment.yml file is needed by this action.  Because I don't want
+          # maintain this but rather maintain the requirements files it just has
+          # basic things in it like conda and pip
+          environment-file: ./environment.yml
+          python-version: 3
+          auto-activate-base: false
+
+      - name: install diffpy.utils requirements
+        shell: bash -l {0}
+        run: |
+          conda config --set always_yes yes --set changeps1 no
+          conda config --add channels conda-forge
+          conda activate test
+          conda install --file requirements/run.txt
+          conda install --file requirements/test.txt
+          pip install .
+
+      - name: Validate diffpy.utils
+        shell: bash -l {0}
+        run: |
+          conda activate test
+          coverage run run_tests.py
+          coverage report -m
+          codecov
+

AUTHORS.txt

@@ -1,4 +1,6 @@
 Pavol Juhas
+Andrew yang
 Timur Davis
 Christopher L. Farrow
 Simon J.L. Billinge
+

environment.yml

@@ -0,0 +1,6 @@
+name: diffpy.utils
+channels:
+  - conda-forge
+dependencies:
+  - python=3
+  - pip

requirements/docs.txt

@@ -0,0 +1,3 @@
+sphinx
+sphinx_rtd_theme
+doctr

requirements/run.txt

@@ -0,0 +1,5 @@
+flake8
+pytest
+codecov
+coverage
+pytest-env

requirements/test.txt

@@ -0,0 +1,17 @@
+#!/usr/bin/env python
+
+import sys
+import pytest
+
+if __name__ == '__main__':
+    # show output results from every test function
+    args = ['-v']
+    # show the message output for skipped and expected failure tests
+    if len(sys.argv) > 1:
+        args.extend(sys.argv[1:])
+    print('pytest arguments: {}'.format(args))
+    # # compute coverage stats for xpdAcq
+    # call pytest and exit with the return code from pytest so that
+    # travis will fail correctly if tests fail
+    exit_res = pytest.main(args)
+    sys.exit(exit_res)