Repository navigation
chore: add Python 3.14 support #31
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 7 commits
d63d6bc
f9fad4f
1dc3297
7e18d23
c12b154
df0d48a
4c5f6be
487bed6
71b558f
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| name: Build and Publish Docs on Dispatch | ||
|
|
||
| on: | ||
| workflow_dispatch: | ||
|
|
||
| jobs: | ||
| get-python-version: | ||
| uses: scikit-package/release-scripts/.github/workflows/_get-python-version-latest.yml@v0 | ||
| with: | ||
| python_version: 0 | ||
|
|
||
| docs: | ||
| uses: scikit-package/release-scripts/.github/workflows/_release-docs.yml@v0 | ||
| with: | ||
| project: diffpy.distanceprinter | ||
| c_extension: false | ||
| headless: false | ||
| python_version: ${{ fromJSON(needs.get-python-version.outputs.latest_python_version) }} |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,18 +1,76 @@ | ||
| name: Release (GitHub/PyPI) and Deploy Docs | ||
| name: Build Wheel and Release | ||
|
|
||
| # Trigger on tag push or manual dispatch. | ||
| # Tag and release privilege are verified inside the reusable workflow. | ||
| on: | ||
| workflow_dispatch: | ||
| push: | ||
| tags: | ||
| - "*" # Trigger on all tags initially, but tag and release privilege are verified in _build-wheel-release-upload.yml | ||
| - "*" | ||
|
|
||
| # ── Release modality ────────────────────────────────────────────────────────── | ||
| # Three options are provided below. Only ONE job should be active at a time. | ||
| # To switch: comment out the active job and uncomment your preferred option, | ||
| # then commit the change to main before tagging a release. | ||
| # ───────────────────────────────────────────────────────────────────────────── | ||
|
|
||
| jobs: | ||
| # Option 1 (default): Release to GitHub, publish to PyPI, and deploy docs. | ||
| # | ||
| # The wheel is uploaded to PyPI so users can install with `pip install`. | ||
| # A GitHub release is created with the changelog as the release body, and | ||
| # the Sphinx documentation is rebuilt and deployed to GitHub Pages. | ||
| # | ||
| # Choose this for open-source packages distributed via PyPI and/or | ||
| # conda-forge where broad public availability is the goal. | ||
| build-release: | ||
| uses: scikit-package/release-scripts/.github/workflows/_build-wheel-release-upload.yml@v0 | ||
| with: | ||
| project: diffpy.distanceprinter | ||
| c_extension: false | ||
| maintainer_GITHUB_username: sbillinge | ||
| maintainer_github_username: sbillinge, bobleesj | ||
| secrets: | ||
| PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }} | ||
| PAT_TOKEN: ${{ secrets.PAT_TOKEN }} | ||
|
|
||
| # Option 2: Release to GitHub and deploy docs, without publishing to PyPI. | ||
| # | ||
| # A GitHub release is created and the Sphinx docs are deployed, but the | ||
| # wheel is not uploaded to PyPI. The source code remains publicly visible | ||
| # on GitHub and can be installed directly from there. | ||
| # | ||
| # Choose this when the package is public but you prefer to keep it off the | ||
| # default pip index — for example, if you distribute via conda-forge only, | ||
| # or if the package is not yet ready for a permanent PyPI presence. | ||
| # | ||
| # To use: comment out Option 1 above and uncomment the lines below. | ||
| # build-release-no-pypi: | ||
| # uses: scikit-package/release-scripts/.github/workflows/_build-release-github-no-pypi.yml@v0 | ||
| # with: | ||
| # project: diffpy.distanceprinter | ||
| # c_extension: false | ||
| # maintainer_github_username: sbillinge, bobleesj | ||
| # secrets: | ||
| # PAT_TOKEN: ${{ secrets.PAT_TOKEN }} | ||
|
|
||
| # Option 3: Release to GitHub with wheel, license, and instructions bundled | ||
| # as a downloadable zip attached to the GitHub release asset. | ||
| # | ||
| # The wheel is built and packaged together with INSTRUCTIONS.txt and the | ||
| # LICENSE file into a zip that is attached directly to the GitHub release. | ||
| # Users with access to the (private) repo download the zip, follow the | ||
| # instructions inside, and install locally with pip. No PyPI or conda-forge | ||
| # upload occurs, and no docs are deployed. | ||
| # | ||
| # Choose this for private or restricted packages where distribution must be | ||
| # controlled: only users with repo access can download the release asset, | ||
| # making the GitHub release itself the distribution channel. | ||
| # | ||
| # To use: comment out Option 1 above and uncomment the lines below. | ||
| # build-release-private: | ||
| # uses: scikit-package/release-scripts/.github/workflows/_build-release-github-private-pure.yml@v0 | ||
| # with: | ||
| # project: diffpy.distanceprinter | ||
| # maintainer_github_username: sbillinge, bobleesj | ||
| # secrets: | ||
| # PAT_TOKEN: ${{ secrets.PAT_TOKEN }} | ||
This file was deleted.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,23 +3,3 @@ Release notes | |
| ============= | ||
|
|
||
| .. current developments | ||
|
|
||
| 1.0.2 | ||
| ===== | ||
|
|
||
|
|
||
| 1.0.1 | ||
| ===== | ||
|
|
||
| **Fixed:** | ||
|
|
||
| * Fixed command line control usability | ||
|
|
||
|
|
||
| 1.0.0 | ||
| ===== | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Please keep all the |
||
|
|
||
| **Changed:** | ||
|
|
||
| * Updated from Python 2.6-2.7 to Python 3.11-3.13 | ||
| * Support ``scikit-package`` Level 5 standard (https://scikit-package.github.io/scikit-package/). | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -67,7 +67,7 @@ Enforcement | |
|
|
||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
| reported to the community leaders responsible for enforcement at | ||
| sb2896@columbia.edu. All complaints will be reviewed and investigated promptly and fairly. | ||
| sbillinge@ucsb.edu and sl5400@columbia.edu. All complaints will be reviewed and investigated promptly and fairly. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We only need the Simon's email here. |
||
|
|
||
| All community leaders are obligated to respect the privacy and security of the | ||
| reporter of any incident. | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| BSD 3-Clause License | ||
|
|
||
| Copyright (c) 2009-2025, The Trustees of Columbia University in the City of New York. | ||
| Copyright (c) 2026, The Trustees of Columbia University in the City of New York. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Same requirement as the license here. |
||
| All rights reserved. | ||
|
|
||
| Redistribution and use in source and binary forms, with or without | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -36,16 +36,18 @@ | |
| .. |Tracking| image:: https://img.shields.io/badge/issue_tracking-github-blue | ||
| :target: https://github.com/diffpy/diffpy.distanceprinter/issues | ||
|
|
||
| Distance Printer, calculate the inter atomic distances. Part of xPDFsuite | ||
| Distance Printer, calculate the inter atomic distances. Part of xPDFsuite. | ||
|
|
||
| * LONGER DESCRIPTION HERE | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. please delete the |
||
|
|
||
| For more information about the diffpy.distanceprinter library, please consult our `online documentation <https://diffpy.github.io/diffpy.distanceprinter>`_. | ||
|
|
||
| Citation | ||
| -------- | ||
|
|
||
| If you use diffpy.distanceprinter in a scientific publication, we would like you to cite this package as | ||
|
|
||
| Xiaohao Yang, Pavol Juhas, Christopher L. Farrow and Simon J. L. Billinge, xPDFsuite: an end-to-end | ||
| software solution for high throughput pair distribution function transformation, visualization and | ||
| analysis, arXiv 1402.3163 (2025) | ||
| diffpy.distanceprinter Package, https://github.com/diffpy/diffpy.distanceprinter | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Please keep the original reference here. |
||
|
|
||
| Installation | ||
| ------------ | ||
|
|
@@ -91,6 +93,11 @@ To view the basic usage and available commands, type :: | |
|
|
||
| diffpy.distanceprinter -h | ||
|
|
||
| Getting Started | ||
| --------------- | ||
|
|
||
| You may consult our `online documentation <https://diffpy.github.io/diffpy.distanceprinter>`_ for tutorials and API references. | ||
|
|
||
| Support and Contribute | ||
| ---------------------- | ||
|
|
||
|
|
@@ -119,15 +126,10 @@ Improvements and fixes are always appreciated. | |
|
|
||
| Before contributing, please read our `Code of Conduct <https://github.com/diffpy/diffpy.distanceprinter/blob/main/CODE-OF-CONDUCT.rst>`_. | ||
|
|
||
| Getting Started | ||
| --------------- | ||
|
|
||
| You may consult our `online documentation <https://diffpy.github.io/diffpy.distanceprinter>`_ for tutorials and API references. | ||
|
|
||
| Contact | ||
| ------- | ||
|
|
||
| For more information on diffpy.distanceprinter please visit the project `web-page <https://www.diffpy.org>`_ or email Simon J.L. Billinge Group at sb2896@columbia.edu. | ||
| For more information on diffpy.distanceprinter please visit the project `web-page <https://diffpy.github.io/>`_ or email the maintainers ``Simon Billinge(sbillinge@ucsb.edu) and Sangjoon Bob Lee(sl5400@columbia.edu)``. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Please here only have Prof. Simon. Thanks |
||
|
|
||
| Acknowledgements | ||
| ---------------- | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,36 +1,36 @@ | ||
| @ECHO OFF | ||
|
|
||
| pushd %~dp0 | ||
|
|
||
| REM Command file for Sphinx documentation | ||
|
|
||
| if "%SPHINXBUILD%" == "" ( | ||
| set SPHINXBUILD=sphinx-build | ||
| ) | ||
| set SOURCEDIR=source | ||
| set BUILDDIR=build | ||
| set SPHINXPROJ=PackagingScientificPython | ||
|
|
||
| if "%1" == "" goto help | ||
|
|
||
| %SPHINXBUILD% >NUL 2>NUL | ||
| if errorlevel 9009 ( | ||
| echo. | ||
| echo.The 'sphinx-build' command was not found. Make sure you have Sphinx | ||
| echo.installed, then set the SPHINXBUILD environment variable to point | ||
| echo.to the full path of the 'sphinx-build' executable. Alternatively you | ||
| echo.may add the Sphinx directory to PATH. | ||
| echo. | ||
| echo.If you don't have Sphinx installed, grab it from | ||
| echo.http://sphinx-doc.org/ | ||
| exit /b 1 | ||
| ) | ||
|
|
||
| %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% | ||
| goto end | ||
|
|
||
| :help | ||
| %SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% | ||
|
|
||
| :end | ||
| popd | ||
| @ECHO OFF | ||
| pushd %~dp0 | ||
| REM Command file for Sphinx documentation | ||
| if "%SPHINXBUILD%" == "" ( | ||
| set SPHINXBUILD=sphinx-build | ||
| ) | ||
| set SOURCEDIR=source | ||
| set BUILDDIR=build | ||
| set SPHINXPROJ=PackagingScientificPython | ||
| if "%1" == "" goto help | ||
| %SPHINXBUILD% >NUL 2>NUL | ||
| if errorlevel 9009 ( | ||
| echo. | ||
| echo.The 'sphinx-build' command was not found. Make sure you have Sphinx | ||
| echo.installed, then set the SPHINXBUILD environment variable to point | ||
| echo.to the full path of the 'sphinx-build' executable. Alternatively you | ||
| echo.may add the Sphinx directory to PATH. | ||
| echo. | ||
| echo.If you don't have Sphinx installed, grab it from | ||
| echo.http://sphinx-doc.org/ | ||
| exit /b 1 | ||
| ) | ||
| %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% | ||
| goto end | ||
| :help | ||
| %SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% | ||
| :end | ||
| popd |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One more things to change here: we only need to keep Simon's github account here.