skpkg: change README, license coverage year, and other files to scikit level-5 standard #25

stevenhua0320 · 2025-10-22T02:00:41Z

@zmx27 Ready to review

zmx27

See comments

zmx27 · 2025-10-22T07:04:57Z

AUTHORS.rst

+Authors
+=======
+
+Simon Billinge, Billinge Group members


Xiaohao Yang and Billinge Group members

zmx27 · 2025-10-22T07:07:54Z

README.rst

+        :target: https://diffpy.github.io/diffpy.srxplanar
+        :height: 100px
+
+|PythonVersion| |PR|


Since this package is open source, I'm guessing that we are likely going to be releasing the package to PyPI/CF? Let's ask Professor Simon to be sure. If so, you can add back the CI and CF, etc flags that skpkg generates

yes, this one can go to pypi and conda-forge

zmx27 · 2025-10-22T07:09:10Z

README.rst

+.. |Tracking| image:: https://img.shields.io/badge/issue_tracking-github-blue
+        :target: https://github.com/diffpy/diffpy.srxplanar/issues
+
+Distance Printer, calculate the inter atomic distances. Part of xPDFsuite


Change description

Just wanted to raise this again. I think this applies to distanceprinter?

Yeah, it should not be here, but originally it is in its description in the project.toml. It is a little bit weird, but I would delete it and retain the other description of this package.

zmx27 · 2025-10-22T07:10:08Z

README.rst

+Citation
+--------
+
+If you use diffpy.srxplanar in a scientific publication, we would like you to cite this package as


The citation info is already in the file. It should be referring to the paper, so maybe move that section here instead?

zmx27 · 2025-10-22T07:10:50Z

README.rst

+------------

-If your python version < 2.7 (these two packages are included in 2.7 but not in 2.6)
+The preferred method is to be installed with `xpdfsuite` package or the wheel file.


Not sure, but if we do end up releasing this package to PyPI/CF, we can also mention how we can install it from there

@zmx27 Professor said we do the package in private repo way yesterday. So, I think we do not need to release it to PyPI/CF?

Got it. Nitpicking here, but maybe we can also add in some instructions on how to install it as a wheel file

zmx27 · 2025-10-22T17:22:08Z

README.rst

+.. |Black| image:: https://img.shields.io/badge/code_style-black-black
+        :target: https://github.com/psf/black
+
+.. |Codecov| image:: https://codecov.io/gh/diffpy/diffpy.srxplanar/branch/main/graph/badge.svg


Since we are not releasing to PyPI/CF like you said, we should be good to delete the Codecov, PyPI icons, etc. Anything that we are not using like Black

zmx27 · 2025-10-22T17:24:04Z

README.rst

+------------

-If your python version < 2.7 (these two packages are included in 2.7 but not in 2.6)
+The preferred method is to be installed with `xpdfsuite` package or the wheel file.


Got it. Nitpicking here, but maybe we can also add in some instructions on how to install it as a wheel file

zmx27 · 2025-10-22T17:24:49Z

README.rst

-    Xiaohao Yang, Pavol Juhas, Simon J. L. Billinge, On the estimation of
-    statistical uncertainties on powder diffraction and small angle
-    scattering data from 2-D x-ray detectors, arXiv:1309.3614
+software.


This is a bit unclear to me, but this paragraph ends with If you are using this software.?

…ription.

zmx27 · 2025-10-22T18:52:33Z

README.rst

+
+|PythonVersion| |PR|
+
+|Tracking|


Sorry, I realized now that my wording was misleading. We do want things like PythonVersion, PR, Tracking, and Black, as well as their associated icons

zmx27 · 2025-10-22T18:52:57Z

README.rst

+.. |Tracking| image:: https://img.shields.io/badge/issue_tracking-github-blue
+        :target: https://github.com/diffpy/diffpy.srxplanar/issues
+
+Distance Printer, calculate the inter atomic distances. Part of xPDFsuite


Just wanted to raise this again. I think this applies to distanceprinter?

zmx27

Looks good

stevenhua0320 · 2025-10-24T01:09:00Z

@sbillinge Ready to review

sbillinge

pls see one comment. Also, on a different PR we will need workflows that do releases to pypi like in scikit package, not like pdfgetx in this case.

sbillinge · 2025-10-24T01:27:07Z

README.rst

+        :target: https://diffpy.github.io/diffpy.srxplanar
+        :height: 100px
+
+|PythonVersion| |PR|


yes, this one can go to pypi and conda-forge

stevenhua0320 · 2025-10-24T01:33:36Z

pls see one comment. Also, on a different PR we will need workflows that do releases to pypi like in scikit package, not like pdfgetx in this case.

OK, I would make edition to all these files in two PRs.

stevenhua0320 · 2025-10-24T02:13:21Z

@sbillinge Ready for README.rst another review

sbillinge

pls see comment

sbillinge · 2025-10-24T03:37:56Z

LICENSE.rst

+BSD 3-Clause License
+
+Copyright (c) 2008-2025, The Trustees of Columbia University in the City of New York.
+Copyright (c) 1994-2025, Christoph Gohlke


Did Christoph Gohlke make edits all the way to this year? I don't know what he contributed, but in any case, leave the dates as they were.

stevenhua0320 added 4 commits October 21, 2025 21:57

skpkg: add config files for authors, changelog, code of conduct, license

d052af8

skpkg: add MANIFEST.in

def081c

skpkg: add README.rst

3ebf91e

skpkg: add news files

f5fc834

zmx27 reviewed Oct 22, 2025

View reviewed changes

skpkg: change citation and correct author name.

9fdb356

zmx27 reviewed Oct 22, 2025

View reviewed changes

style: add instruction of install by wheel, change badge and fix desc…

98c00c7

…ription.

zmx27 reviewed Oct 22, 2025

View reviewed changes

style: change badge, and description of the package.

273ae68

stevenhua0320 requested a review from zmx27 October 23, 2025 14:41

zmx27 reviewed Oct 24, 2025

View reviewed changes

sbillinge reviewed Oct 24, 2025

View reviewed changes

stevenhua0320 added 2 commits October 23, 2025 21:43

style: add Codecov and PyPI icon back to README.tsy

2b7d92b

style: add CI, pypi, and conda-forge icon

564ed6e

sbillinge reviewed Oct 24, 2025

View reviewed changes

chore: change license year coverage for Christoph Gohlke.

2082643

sbillinge merged commit 6286a4d into diffpy:migration Oct 24, 2025

zmx27 mentioned this pull request Oct 24, 2025

style: update CODE_OF_CONDUCT.rst, test.txt, and doc/ to new group standard #6

Closed

skpkg: change README, license coverage year, and other files to scikit level-5 standard #25

skpkg: change README, license coverage year, and other files to scikit level-5 standard #25

Uh oh!

Conversation

stevenhua0320 commented Oct 22, 2025

Uh oh!

zmx27 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zmx27 left a comment

Choose a reason for hiding this comment

Uh oh!

stevenhua0320 commented Oct 24, 2025

Uh oh!

sbillinge left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

stevenhua0320 commented Oct 24, 2025

Uh oh!

stevenhua0320 commented Oct 24, 2025

Uh oh!

sbillinge left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants