Skip to content

Commit 2c02eb3

Browse files
authored
Merge pull request #43 from zmx27/remove-pip
chore: remove srxconfutils pip install from ci and update package entry point
2 parents 584597e + 161debe commit 2c02eb3

File tree

4 files changed

+29
-6
lines changed

4 files changed

+29
-6
lines changed

.github/workflows/matrix-and-codecov-on-merge-to-main.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,6 @@ jobs:
1717
project: diffpy.srxplanar
1818
c_extension: false
1919
headless: false
20-
run: |
21-
pip install diffpy.srxconfutils
2220

2321
secrets:
2422
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/tests-on-pr.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,5 @@ jobs:
1212
c_extension: false
1313
headless: false
1414
python_version: 3.13
15-
run: |
16-
pip install diffpy.srxconfutils
1715
secrets:
1816
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

README.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,10 @@ The following creates and activates a new environment named ``diffpy.srxplanar_e
7777
conda create -n diffpy.srxplanar_env diffpy.srxplanar
7878
conda activate diffpy.srxplanar_env
7979

80+
To confirm that the installation was successful, type ::
81+
82+
python -c "import diffpy.srxplanar; print(diffpy.srxplanar.__version__)"
83+
8084
The output should print the latest version displayed on the badges above.
8185

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

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

96-
diffpy.srxplanar --version
100+
diffpy-srxplanar --version
97101

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

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

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

105-
diffpy.srxplanar -h
109+
diffpy-srxplanar -h
106110

107111
Getting Started
108112
---------------

news/remove-pip.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
**Added:**
2+
3+
* No news added: Remove confutils from pip install in ci.
4+
5+
**Changed:**
6+
7+
* <news item>
8+
9+
**Deprecated:**
10+
11+
* <news item>
12+
13+
**Removed:**
14+
15+
* <news item>
16+
17+
**Fixed:**
18+
19+
* <news item>
20+
21+
**Security:**
22+
23+
* <news item>

0 commit comments

Comments
 (0)