Revisions following test run

merely-useful / py-rse

Research Software Engineering with Python course material

http://third-bit.com/py-rse/

Other

246 stars 63 forks source link

Revisions following test run #560

Closed k8hertweck closed 3 years ago

k8hertweck commented 3 years ago

Starting with git-cmdline, when Amira's repo is tracked, these are revisions that reconcile what the final repo will look like, the scripts in this repo's zipf directory, and exercises/solutions. It's a continuation of #554 and continues resolving issues mentioned there.

There were more changes than I anticipated. Major alternations include:

updating git output messages and commit numbers
updating exercises to avoid readers having conflicts in future chapters
updating solutions to match current exercises

I've been thinking it might be useful to add lightweight tags in Amira's repo to label the code in different chapters, and to differentiate the "hard copy" version of code from books.

DamienIrving commented 3 years ago

When you get to the packaging chapter, you might want to update to the latest version of pip.

$ python -m pip install --upgrade pip

There's just been an "important and disruptive" new release (see details here), which might change some of the output when Amira runs pip commands.

k8hertweck commented 3 years ago

Thanks for the heads up!

k8hertweck commented 3 years ago

I haven't included the following in Amira's repo since we don't need images and it won't affect the rest of the repo (these are all exercises):

DamienIrving commented 3 years ago

From https://github.com/merely-useful/py-rse/pull/562#discussion_r532844009

@k8hertweck Once you're done with the test run, do you want to add a call-out box to Section 1.3 (Installing the Software) mentioning what version of git, python, bash and make you/Amira used when writing the book? The idea is to alert the reader to the fact that if their output looks slightly different than ours, the difference might be due to different versions.

k8hertweck commented 3 years ago

Got it, covered in a757b7e

k8hertweck commented 3 years ago

Amira's repo isn't quite complete yet (I have a few things to sort out in the packaging chapter), but I think this repo is about as solid as I can make it.

I had trouble using pip inside conda, and deliberated whether to include a note about using conda install pip as a work-around, but ultimately didn't. Because of this, I didn't update most of the output to reflect what I actually saw, but any differences I imagine were trivial (though I updated version numbers so they had the semblance of consistency).

Remaining tasks for Amira:

[x] package to testPyPI
[x] PyPI
[x] Read the Docs
[x] finalize commits for packaging chapter (for https://github.com/amira-khan/zipf)
[ ] tag/release "final" code for book (not sure if this should be just prior to the packaging chapter, or after?)
[ ] add tags for each chapter?

DamienIrving commented 3 years ago

Note: I just made a commit (https://github.com/merely-useful/py-rse/pull/560/commits/ecbaea9d3f30bf01c101b6d440981c59f29918f8) to remove some lingering references to /Users/amira/opt/anaconda3 (the default path for Anaconda on MacOS if you use the graphical installer) when it should be /Users/amira/anaconda3 (the default path for the shell installer, which is what Kate/Amira has used). This page shows all the default paths: https://docs.anaconda.com/anaconda/user-guide/faq/#installing-anaconda

k8hertweck commented 3 years ago

Alright, I think the packaging chapter is more generally workable. @DamienIrving, could you take a quick look at the most recent changes?

DamienIrving commented 3 years ago

Looks good to me. I'm glad you caught that issue with pip :smile:

k8hertweck commented 3 years ago

Thanks so much for pointing me towards a workable solution!

I'm SO EXCITED to slam this merge button...