Skip to content

Conversation

@zmx27
Copy link
Collaborator

@zmx27 zmx27 commented Oct 28, 2025

No description provided.

@zmx27
Copy link
Collaborator Author

zmx27 commented Oct 28, 2025

@sbillinge ready for review. As I was going through the checklist for the release issue, I realized that the docs won't build, among other things. This PR serves to fix the issues I've noticed. The docs now build:
image

Wow, I keep noticing more issues haha

@@ -0,0 +1,33 @@
import argparse
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CLI utility provided by skpkg. Got this from package update


[project.scripts]
diffpy-distanceprinter = "diffpy.distanceprinter:main"
diffpy-distanceprinter = "diffpy.distanceprinter.distanceprinter_app:main"
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Points to the file src/diffpy/distanceprinter/distanceprinter_app.py

@zmx27 zmx27 changed the title skpkg: add cookiecutter.json, fix rendering issues in readme, add index.rst so docs will build skpkg: add cookiecutter.json, fix rendering issues in readme, add index.rst, add conftest.py, update requirements folder, update manifest.in Oct 28, 2025
@zmx27 zmx27 mentioned this pull request Oct 28, 2025
18 tasks
@sbillinge
Copy link
Contributor

please paste the results of running pytest locally. Also please check that all the requirements files are present and up to date. T hen I can merge

@zmx27
Copy link
Collaborator Author

zmx27 commented Oct 28, 2025

Here is the result of running pytest locally:

================================= test session starts =================================
platform darwin -- Python 3.13.9, pytest-8.4.2, pluggy-1.6.0
rootdir: /Users/zhimingxu/BillingeGroup/diffpy.distanceprinter
configfile: pyproject.toml
plugins: env-1.2.0, cov-7.0.0
collected 2 items

tests/test_distanceprinter.py .                                                 [ 50%]
tests/test_version.py .                                                         [100%]

================================== 2 passed in 1.23s ==================================

And yes, with the addition of pip.txt in this PR, all of the requirements files are present and up to date.

@sbillinge sbillinge merged commit 84acda7 into diffpy:main Oct 29, 2025
0 of 2 checks passed
@sbillinge
Copy link
Contributor

Let me know when this is ready for release

@sbillinge
Copy link
Contributor

It is in my mind to make this public too. I think it could be widely useful. Please could you look into that? We would need to give it the same treatment we gave srxconfutils

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants