From e00efde8d56134f9a9ce8703f15b77a5480ee62b Mon Sep 17 00:00:00 2001 From: Zhi Ming Xu Date: Wed, 1 Oct 2025 02:40:22 -0400 Subject: [PATCH 1/5] skpkg: add public facing files like authors, changelog, code-of-conduct, license --- AUTHORS.rst | 11 ++++ CHANGELOG.rst | 5 ++ CODE-OF-CONDUCT.rst | 133 ++++++++++++++++++++++++++++++++++++++++++++ LICENSENOTICE.rst | 10 ++++ 4 files changed, 159 insertions(+) create mode 100644 AUTHORS.rst create mode 100644 CHANGELOG.rst create mode 100644 CODE-OF-CONDUCT.rst create mode 100644 LICENSENOTICE.rst diff --git a/AUTHORS.rst b/AUTHORS.rst new file mode 100644 index 0000000..05b7097 --- /dev/null +++ b/AUTHORS.rst @@ -0,0 +1,11 @@ +Authors +======= + +Xiaohao Yang +Billinge Group members + +Contributors +------------ + +For a list of contributors, visit +https://github.com/diffpy/diffpy.srxconfutils/graphs/contributors diff --git a/CHANGELOG.rst b/CHANGELOG.rst new file mode 100644 index 0000000..f29d3b5 --- /dev/null +++ b/CHANGELOG.rst @@ -0,0 +1,5 @@ +============= +Release notes +============= + +.. current developments diff --git a/CODE-OF-CONDUCT.rst b/CODE-OF-CONDUCT.rst new file mode 100644 index 0000000..e8199ca --- /dev/null +++ b/CODE-OF-CONDUCT.rst @@ -0,0 +1,133 @@ +===================================== + Contributor Covenant Code of Conduct +===================================== + +Our Pledge +---------- + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socioeconomic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +Our Standards +------------- + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall + community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or advances of + any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email address, + without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +Enforcement Responsibilities +---------------------------- + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +Scope +----- + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official email address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +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. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +Enforcement Guidelines +---------------------- + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +1. Correction +**************** + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +2. Warning +************* + +**Community Impact**: A violation through a single incident or series of +actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or permanent +ban. + +3. Temporary Ban +****************** + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +4. Permanent Ban +****************** + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the +community. + +Attribution +----------- + +This Code of Conduct is adapted from the `Contributor Covenant `_. + +Community Impact Guidelines were inspired by `Mozilla's code of conduct enforcement ladder `_. + +For answers to common questions about this code of conduct, see the `FAQ `_. `Translations are available `_ diff --git a/LICENSENOTICE.rst b/LICENSENOTICE.rst new file mode 100644 index 0000000..db80319 --- /dev/null +++ b/LICENSENOTICE.rst @@ -0,0 +1,10 @@ +Use of this software is subject to and permitted only under a separate, +written Use License granted by Columbia University. If you or your employer +is not a party to such an agreement, then your use of this software is +prohibited. If you don’t know whether or not your anticipated use is under +a license, you must contact Prof. Simon Billinge at sb2896@columbia.edu. +Use of this software without a license is prohibited. + +Copyright 2009-2025, Trustees of Columbia University in the City of New York. + +For more information please email Prof. Simon Billinge at sb2896@columbia.edu From 16f5d7cee6158d9ecab404ad9f6bd7bc17eb5260 Mon Sep 17 00:00:00 2001 From: Zhi Ming Xu Date: Wed, 1 Oct 2025 02:42:03 -0400 Subject: [PATCH 2/5] chore: delete old authors and licensenotice files --- AUTHORS.txt | 7 ------- LICENSENOTICE.txt | 10 ---------- 2 files changed, 17 deletions(-) delete mode 100644 AUTHORS.txt delete mode 100644 LICENSENOTICE.txt diff --git a/AUTHORS.txt b/AUTHORS.txt deleted file mode 100644 index cddf273..0000000 --- a/AUTHORS.txt +++ /dev/null @@ -1,7 +0,0 @@ -This code is developed by: - - Xiaohao Yang - -This code was developed as part of the xPDFsuite project to create software -and tools for general researchers to use PDF in their work. For more -information on the DiffPy project email sb2896@columbia.edu diff --git a/LICENSENOTICE.txt b/LICENSENOTICE.txt deleted file mode 100644 index 8fc8b60..0000000 --- a/LICENSENOTICE.txt +++ /dev/null @@ -1,10 +0,0 @@ -Use of this software is subject to and permitted only under a separate, -written Use License granted by Columbia University. If you or your employer -is not a party to such an agreement, then your use of this software is -prohibited. If you don’t know whether or not your anticipated use is under -a license, you must contact Prof. Simon Billinge at sb2896@columbia.edu. -Use of this software without a license is prohibited. - -Copyright 2009-2016, Trustees of Columbia University in the City of New York. - -For more information please email Prof. Simon Billinge at sb2896@columbia.edu From de24e9a064b6b8bb3a987dd15f03274b59afb043 Mon Sep 17 00:00:00 2001 From: Zhi Ming Xu Date: Wed, 1 Oct 2025 02:45:57 -0400 Subject: [PATCH 3/5] skpkg: add MANIFEST.in --- MANIFEST.in | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/MANIFEST.in b/MANIFEST.in index 982d898..f1a78ee 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,3 +1,12 @@ -recursive-include dpx * -prune doc -exclude MANIFEST.in +graft src +graft tests +graft requirements + +include AUTHORS.rst LICENSE*.rst README.rst + +# Exclude all bytecode files and __pycache__ directories +global-exclude *.py[cod] # Exclude all .pyc, .pyo, and .pyd files. +global-exclude .DS_Store # Exclude Mac filesystem artifacts. +global-exclude __pycache__ # Exclude Python cache directories. +global-exclude .git* # Exclude git files and directories. +global-exclude .idea # Exclude PyCharm project settings. From 9f2927d5d0bde0178bc9670d41514fb9aa13d542 Mon Sep 17 00:00:00 2001 From: Zhi Ming Xu Date: Wed, 1 Oct 2025 02:46:28 -0400 Subject: [PATCH 4/5] skpkg: add cookiecutter.json --- cookiecutter.json | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 cookiecutter.json diff --git a/cookiecutter.json b/cookiecutter.json new file mode 100644 index 0000000..629bacd --- /dev/null +++ b/cookiecutter.json @@ -0,0 +1,18 @@ +{ + "maintainer_name": "Simon J.L. Billinge group", + "maintainer_email": "sb2896@columbia.edu", + "maintainer_github_username": "sbillinge", + "contributors": "Billinge Group members", + "license_holders": "The Trustees of Columbia University in the City of New York", + "project_name": "diffpy.srxconfutils", + "github_username_or_orgname": "diffpy", + "github_repo_name": "diffpy.srxconfutils", + "conda_pypi_package_dist_name": "diffpy.srxconfutils", + "package_dir_name": "diffpy.srxconfutils", + "project_short_description": "Configuration utilities for project. Part of xPDFsuite", + "project_keywords": "diffpy, pdf, data interpretation", + "minimum_supported_python_version": "3.11", + "maximum_supported_python_version": "3.13", + "project_needs_c_code_compiled": "No", + "project_has_gui_tests": "No" +} From 4bf6b4a0bf2ba62cdd477f899bed16c6b4255651 Mon Sep 17 00:00:00 2001 From: Zhi Ming Xu Date: Wed, 1 Oct 2025 02:48:32 -0400 Subject: [PATCH 5/5] chore: add indent to author names in authors.rst --- AUTHORS.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/AUTHORS.rst b/AUTHORS.rst index 05b7097..bbc8c0d 100644 --- a/AUTHORS.rst +++ b/AUTHORS.rst @@ -1,8 +1,8 @@ Authors ======= -Xiaohao Yang -Billinge Group members + Xiaohao Yang + Billinge Group members Contributors ------------