Skip to content

Commit 33dc879

Browse files
ycexiaoycexiao
committed
chore: skpkg update
1 parent e39b803 commit 33dc879

16 files changed

Lines changed: 201 additions & 107 deletions

‎.github/workflows/build-and-publish-docs-on-dispatch.yml‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: Build and Publish Docs on Dispatch
2+
3+
on:
4+
workflow_dispatch:
5+
6+
jobs:
7+
get-python-version:
8+
uses: scikit-package/release-scripts/.github/workflows/_get-python-version-latest.yml@v0
9+
with:
10+
python_version: 0
11+
12+
docs:
13+
uses: scikit-package/release-scripts/.github/workflows/_release-docs.yml@v0
14+
with:
15+
project: diffpy.apps
16+
c_extension: false
17+
headless: false
18+
python_version: ${{ fromJSON(needs.get-python-version.outputs.latest_python_version) }}

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

Lines changed: 61 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,76 @@
1-
name: Release (GitHub/PyPI) and Deploy Docs
1+
name: Build Wheel and Release
22

3+
# Trigger on tag push or manual dispatch.
4+
# Tag and release privilege are verified inside the reusable workflow.
35
on:
46
workflow_dispatch:
57
push:
68
tags:
7-
- "*" # Trigger on all tags initially, but tag and release privilege are verified in _build-wheel-release-upload.yml
9+
- "*"
10+
11+
# ── Release modality ──────────────────────────────────────────────────────────
12+
# Three options are provided below. Only ONE job should be active at a time.
13+
# To switch: comment out the active job and uncomment your preferred option,
14+
# then commit the change to main before tagging a release.
15+
# ─────────────────────────────────────────────────────────────────────────────
816

917
jobs:
18+
# Option 1 (default): Release to GitHub, publish to PyPI, and deploy docs.
19+
#
20+
# The wheel is uploaded to PyPI so users can install with `pip install`.
21+
# A GitHub release is created with the changelog as the release body, and
22+
# the Sphinx documentation is rebuilt and deployed to GitHub Pages.
23+
#
24+
# Choose this for open-source packages distributed via PyPI and/or
25+
# conda-forge where broad public availability is the goal.
1026
build-release:
1127
uses: scikit-package/release-scripts/.github/workflows/_build-wheel-release-upload.yml@v0
1228
with:
1329
project: diffpy.apps
1430
c_extension: false
15-
maintainer_GITHUB_username: sbillinge
31+
maintainer_github_username: sbillinge
1632
secrets:
1733
PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
1834
PAT_TOKEN: ${{ secrets.PAT_TOKEN }}
35+
36+
# Option 2: Release to GitHub and deploy docs, without publishing to PyPI.
37+
#
38+
# A GitHub release is created and the Sphinx docs are deployed, but the
39+
# wheel is not uploaded to PyPI. The source code remains publicly visible
40+
# on GitHub and can be installed directly from there.
41+
#
42+
# Choose this when the package is public but you prefer to keep it off the
43+
# default pip index — for example, if you distribute via conda-forge only,
44+
# or if the package is not yet ready for a permanent PyPI presence.
45+
#
46+
# To use: comment out Option 1 above and uncomment the lines below.
47+
# build-release-no-pypi:
48+
# uses: scikit-package/release-scripts/.github/workflows/_build-release-github-no-pypi.yml@v0
49+
# with:
50+
# project: diffpy.apps
51+
# c_extension: false
52+
# maintainer_github_username: sbillinge
53+
# secrets:
54+
# PAT_TOKEN: ${{ secrets.PAT_TOKEN }}
55+
56+
# Option 3: Release to GitHub with wheel, license, and instructions bundled
57+
# as a downloadable zip attached to the GitHub release asset.
58+
#
59+
# The wheel is built and packaged together with INSTRUCTIONS.txt and the
60+
# LICENSE file into a zip that is attached directly to the GitHub release.
61+
# Users with access to the (private) repo download the zip, follow the
62+
# instructions inside, and install locally with pip. No PyPI or conda-forge
63+
# upload occurs, and no docs are deployed.
64+
#
65+
# Choose this for private or restricted packages where distribution must be
66+
# controlled: only users with repo access can download the release asset,
67+
# making the GitHub release itself the distribution channel.
68+
#
69+
# To use: comment out Option 1 above and uncomment the lines below.
70+
# build-release-private:
71+
# uses: scikit-package/release-scripts/.github/workflows/_build-release-github-private-pure.yml@v0
72+
# with:
73+
# project: diffpy.apps
74+
# maintainer_github_username: sbillinge
75+
# secrets:
76+
# PAT_TOKEN: ${{ secrets.PAT_TOKEN }}

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: Check for News
33
on:
44
pull_request_target:
55
branches:
6-
- main
6+
- main # GitHub does not evaluate expressions in trigger filters; edit this value if your base branch is not main
77

88
jobs:
99
check-news-item:

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
1-
name: CI
1+
name: Matrix and Codecov
22

33
on:
4+
# push:
5+
# branches:
6+
# - main
47
release:
58
types:
69
- prereleased
@@ -14,6 +17,5 @@ jobs:
1417
project: diffpy.apps
1518
c_extension: false
1619
headless: false
17-
python_versions: 3.12, 3.13
1820
secrets:
1921
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

‎.github/workflows/release-docs.yml‎

Lines changed: 0 additions & 11 deletions
This file was deleted.

‎.pre-commit-config.yaml‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
default_language_version:
2-
python: python3
2+
python: python3.13
33
ci:
44
autofix_commit_msg: |
55
[pre-commit.ci] auto fixes from pre-commit hooks
@@ -29,7 +29,7 @@ repos:
2929
hooks:
3030
- id: flake8
3131
- repo: https://github.com/pycqa/isort
32-
rev: 8.0.1
32+
rev: 9.0.0a3
3333
hooks:
3434
- id: isort
3535
args: ["--profile", "black"]
@@ -57,10 +57,11 @@ repos:
5757
- id: prettier
5858
additional_dependencies:
5959
- "prettier@^3.2.4"
60-
types: [yaml, markdown, json]
61-
# ruff - An extremely fast Python linter and code formatter, written in Rust.
62-
- repo: https://github.com/astral-sh/ruff-pre-commit
63-
rev: v0.15.12
60+
# docformatter - PEP 257 compliant docstring formatter
61+
- repo: https://github.com/PyCQA/docformatter
62+
rev: v1.7.8
6463
hooks:
65-
- id: ruff-check
66-
args: [--fix, --config=pyproject.toml]
64+
- id: docformatter
65+
additional_dependencies: [tomli]
66+
args: [--in-place, --config, ./pyproject.toml]
67+
exclude: ^tests/test_runmacro\.py$

‎CODE-OF-CONDUCT.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ Enforcement
6767

6868
Instances of abusive, harassing, or otherwise unacceptable behavior may be
6969
reported to the community leaders responsible for enforcement at
70-
yx2924@columbia.edu and sbillinge@ucsb.edu. All complaints will be reviewed and investigated promptly and fairly.
70+
sbillinge@ucsb.edu. All complaints will be reviewed and investigated promptly and fairly.
7171

7272
All community leaders are obligated to respect the privacy and security of the
7373
reporter of any incident.

‎cookiecutter.json‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
{
22
"author_names": "Yuchen Xiao, Simon Billinge",
3-
"author_emails": "yx2924@columbia.edu, sbillinge@ucsb.edu",
4-
"maintainer_names": "Yuchen Xiao, Simon Billinge",
5-
"maintainer_emails": "yx2924@columbia.edu, sbillinge@ucsb.edu",
3+
"author_emails": "xiaoyuch@msu.edu, sbillinge@ucsb.edu",
4+
"maintainer_names": "Simon Billinge",
5+
"maintainer_emails": "sbillinge@ucsb.edu",
66
"maintainer_github_usernames": "sbillinge",
77
"contributors": "Yuchen Xiao, Simon Billinge and members of the Billinge group",
8-
"license_holders": "diffpy.apps contributors",
98
"project_name": "diffpy.apps",
9+
"license_holders": "diffpy.apps contributors",
1010
"github_username_or_orgname": "diffpy",
1111
"github_repo_name": "diffpy.apps",
1212
"conda_pypi_package_dist_name": "diffpy.apps",

‎docs/make.bat‎

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,36 @@
1-
@ECHO OFF
2-
3-
pushd %~dp0
4-
5-
REM Command file for Sphinx documentation
6-
7-
if "%SPHINXBUILD%" == "" (
8-
set SPHINXBUILD=sphinx-build
9-
)
10-
set SOURCEDIR=source
11-
set BUILDDIR=build
12-
set SPHINXPROJ=PackagingScientificPython
13-
14-
if "%1" == "" goto help
15-
16-
%SPHINXBUILD% >NUL 2>NUL
17-
if errorlevel 9009 (
18-
echo.
19-
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
20-
echo.installed, then set the SPHINXBUILD environment variable to point
21-
echo.to the full path of the 'sphinx-build' executable. Alternatively you
22-
echo.may add the Sphinx directory to PATH.
23-
echo.
24-
echo.If you don't have Sphinx installed, grab it from
25-
echo.http://sphinx-doc.org/
26-
exit /b 1
27-
)
28-
29-
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
30-
goto end
31-
32-
:help
33-
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
34-
35-
:end
36-
popd
1+
@ECHO OFF
2+
3+
pushd %~dp0
4+
5+
REM Command file for Sphinx documentation
6+
7+
if "%SPHINXBUILD%" == "" (
8+
set SPHINXBUILD=sphinx-build
9+
)
10+
set SOURCEDIR=source
11+
set BUILDDIR=build
12+
set SPHINXPROJ=PackagingScientificPython
13+
14+
if "%1" == "" goto help
15+
16+
%SPHINXBUILD% >NUL 2>NUL
17+
if errorlevel 9009 (
18+
echo.
19+
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
20+
echo.installed, then set the SPHINXBUILD environment variable to point
21+
echo.to the full path of the 'sphinx-build' executable. Alternatively you
22+
echo.may add the Sphinx directory to PATH.
23+
echo.
24+
echo.If you don't have Sphinx installed, grab it from
25+
echo.http://sphinx-doc.org/
26+
exit /b 1
27+
)
28+
29+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
30+
goto end
31+
32+
:help
33+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
34+
35+
:end
36+
popd

‎docs/source/index.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ To get started, please visit the :ref:`Getting started <getting-started>` page.
2121
Authors
2222
=======
2323

24-
``diffpy.apps`` is developed by Yuchen Xiao, Simon Billinge and members of the Billinge group. This project is maintained by Yuchen Xiao and Simon Billinge. For a detailed list of contributors see
24+
``diffpy.apps`` is developed by Yuchen Xiao, Simon Billinge and members of the Billinge group. This project is maintained by Simon Billinge. For a detailed list of contributors see
2525
https://github.com/diffpy/diffpy.apps/graphs/contributors.
2626

2727
============

0 commit comments

Comments
 (0)