skpkg: add CHAGELOG.rst, README.rst, license, update pyproject.toml #150
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## migration #150 +/- ##
==========================================
Coverage 98.97% 98.97%
==========================================
Files 6 6
Lines 1267 1267
==========================================
Hits 1254 1254
Misses 13 13 🚀 New features to boost your workflow:
|
sbillinge
left a comment
sbillinge
left a comment
There was a problem hiding this comment.
ok, good progress. Please see my comments. We need to change things up a little bit.
| ============= | ||
|
|
||
| .. current developments | ||
There was a problem hiding this comment.
we need to keep all of this. The changelog is updated at each release, by inserting new things at the top. So we need all of this legacy stuff.
| To install using ``pip`` into your ``diffpy.pdffit2_env`` environment, type :: | ||
|
|
||
| conda create -n diffpy.pdffit2_env python=3.13 | ||
| pip install diffpy.pdffit2 |
There was a problem hiding this comment.
instructions here need to be changed to be the same as the instructions in INSTRUCTIONS.txt I think
There was a problem hiding this comment.
Should it be maintained as the original form of installation guide as before? I don't think we have a INSTRUCTIONS.txt in this package.
There was a problem hiding this comment.
ah, you are right. I was getting confused. Yes, in that case keep it as it was before. I don't think anything changed.
README.rst
Outdated
| pip install . | ||
|
|
||
| Install pdffit2 using ``pip`` to download and install the latest version from `Python Package Index <https://pypi.python.org>`_: :: | ||
| This package also provides command-line utilities. To check the software has been installed correctly, type :: |
There was a problem hiding this comment.
this also needs to be updated as I don't think we have a cli for this program. If we do it just returns version to make sure the installation was correct, but it is never used this way.
2 participants
@sbillinge Ready to review, note that not sure whether we need to maintain the CHANGELOG.rst as it is deleted automatically by
package update