Skip to content

chore: remove srxconfutils pip install from ci and update package entry point #43

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Nov 15, 2025
+29 −6
Merged

chore: remove srxconfutils pip install from ci and update package entry point #43

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bf58b52
chore: remove confutils pip install in ci now that its on cf
zmx27 Nov 13, 2025
5bde256
chore: match pyproject entry point for srxplanar with readme
zmx27 Nov 13, 2025
b28122e
skpkg: add news file
zmx27 Nov 13, 2025
161debe
chore: change back to diffpy-srxplanar
zmx27 Nov 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions .github/workflows/matrix-and-codecov-on-merge-to-main.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,6 @@ jobs:
project: diffpy.srxplanar
c_extension: false
headless: false
run: |
pip install diffpy.srxconfutils

secrets:
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
2 changes: 0 additions & 2 deletions .github/workflows/tests-on-pr.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,5 @@ jobs:
c_extension: false
headless: false
python_version: 3.13
run: |
pip install diffpy.srxconfutils
secrets:
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
8 changes: 6 additions & 2 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,10 @@ The following creates and activates a new environment named ``diffpy.srxplanar_e
conda create -n diffpy.srxplanar_env diffpy.srxplanar
conda activate diffpy.srxplanar_env

To confirm that the installation was successful, type ::

python -c "import diffpy.srxplanar; print(diffpy.srxplanar.__version__)"

The output should print the latest version displayed on the badges above.

If the above does not work, you can use ``pip`` to download and install the latest release from
Expand All @@ -93,7 +97,7 @@ and run the following ::

This package also provides command-line utilities. To check the software has been installed correctly, type ::

diffpy.srxplanar --version
diffpy-srxplanar --version
Copy link
Contributor

@sbillinge sbillinge Nov 13, 2025

Choose a reason for hiding this comment

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

I think the command line app can just be called srxplanar. Less for folks to type


You can also type the following command to verify the installation. ::

Expand All @@ -102,7 +106,7 @@ You can also type the following command to verify the installation. ::

To view the basic usage and available commands, type ::

diffpy.srxplanar -h
diffpy-srxplanar -h

Getting Started
---------------
Expand Down
23 changes: 23 additions & 0 deletions news/remove-pip.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
**Added:**

* No news added: Remove confutils from pip install in ci.

**Changed:**

* <news item>

**Deprecated:**

* <news item>

**Removed:**

* <news item>

**Fixed:**

* <news item>

**Security:**

* <news item>
Loading