Migration (#172)

* skpkg: set up scaffold and moved over docs, src, tests, news (#165)

* fix: chagned line length to 115

* chore: move LICENSE files over to scaffold

* fix: Fixed issues with pyproject.toml

* chore: move necessary files over to scaffold (#166)

* fix: chagned line length to 115

* chore: move LICENSE files over to scaffold

* chore: github workflows, codecovs, codespell

* chore: maintenance on CHANGLOG CODE_OF_CONDUCT etc

* chore: move neccessary files over, clean up ones that arent needed

* skpkg: fix pyproject.toml

* [pre-commit.ci] auto fixes from pre-commit hooks

* chore: Replace scikit-package-logo-text.png and example-table.rst with placeholder files, fix docformatter for arbitrary.py

* [pre-commit.ci] auto fixes from pre-commit hooks

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* chore: move over rest of doc and src files (#168)

* chore: move over rest of doc and src files

* chore: run pre-commit

* chore: fix index.rst back to original

* Rename doc → docs, update references, and fix test.txt (#171)

---------

Co-authored-by: kwagoner94 <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: 3 people

.codecov.yml

@@ -1,14 +1,14 @@
 coverage:
   status:
-    project:  # more options at https://docs.codecov.com/docs/commit-status
+    project: # more options at https://docs.codecov.com/docs/commit-status
       default:
         target: auto # use the coverage from the base commit, fail if coverage is lower
-        threshold: 0%  # allow the coverage to drop by
+        threshold: 0% # allow the coverage to drop by
 
 comment:
   layout: " diff, flags, files"
   behavior: default
   require_changes: false
-  require_base: false  # [true :: must have a base report to post]
-  require_head: false  # [true :: must have a head report to post]
+  require_base: false # [true :: must have a base report to post]
+  require_head: false # [true :: must have a head report to post]
   hide_project_coverage: false # [true :: only show coverage on the git diff aka patch coverage]

.codespell/ignore_words.txt

@@ -4,8 +4,5 @@
 ;; abbreviation for "materials" often used in a journal title
 mater
 
-;; alternative use of socioeconomic
-socio-economic
-
 ;; Frobenius norm used in np.linalg.norm
 fro

.flake8

@@ -1,3 +1,5 @@
+# As of now, flake8 does not natively support configuration via pyproject.toml
+# https://github.com/microsoft/vscode-flake8/issues/135
 [flake8]
 exclude =
     .git,

.github/ISSUE_TEMPLATE/release_checklist.md

@@ -4,13 +4,15 @@ on:
   workflow_dispatch:
   push:
     tags:
-      - '*'  # Trigger on all tags initially, but tag and release privilege are verified in _build-wheel-release-upload.yml
+      - "*" # Trigger on all tags initially, but tag and release privilege are verified in _build-wheel-release-upload.yml
 
 jobs:
   release:
-    uses: Billingegroup/release-scripts/.github/workflows/_build-wheel-release-upload.yml@v0
+    uses: scikit-package/release-scripts/.github/workflows/_build-wheel-release-upload.yml@v0
     with:
       project: diffpy.srmise
+      c_extension: false
+      maintainer_GITHUB_username: sbillinge
     secrets:
       PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
       PAT_TOKEN: ${{ secrets.PAT_TOKEN }}

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -3,10 +3,10 @@ name: Check for News
 on:
   pull_request_target:
     branches:
-    - main
+      - main
 
 jobs:
-  build:
-    uses: Billingegroup/release-scripts/.github/workflows/_check-news-item.yml@v0
+  check-news-item:
+    uses: scikit-package/release-scripts/.github/workflows/_check-news-item.yml@v0
     with:
       project: diffpy.srmise

.github/workflows/build-wheel-release-upload.yml

@@ -11,8 +11,8 @@ on:
   workflow_dispatch:
 
 jobs:
-  coverage:
-    uses: Billingegroup/release-scripts/.github/workflows/_matrix-and-codecov-on-merge-to-main.yml@v0
+  matrix-coverage:
+    uses: scikit-package/release-scripts/.github/workflows/_matrix-and-codecov-on-merge-to-main.yml@v0
     with:
       project: diffpy.srmise
       c_extension: false

.github/workflows/check-news-item.yml

@@ -0,0 +1,12 @@
+name: Deploy Documentation on Release
+
+on:
+  workflow_dispatch:
+
+jobs:
+  docs:
+    uses: scikit-package/release-scripts/.github/workflows/_publish-docs-on-release.yml@v0
+    with:
+      project: diffpy.srmise
+      c_extension: false
+      headless: false

.github/workflows/matrix-and-codecov-on-merge-to-main.yml

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