Update section 4

[rogerkuou]

Fix #7

Now 4.2 focuses more on "re-use", including topics: documentation, pyproject.toml, cff file, license

4.3 focuses more one "release", including topics: version tagging, packaging.

---

Major changes:

4.1 Code review

• Move the command line merging here

4.2 Preparing Software for Reuse

• At beginning, mention working in a branch
• remove "release" related parts and move it to 4.3
• Keep the old README doc part
• Add mkdocs to the docmentation part. Referencing: https://carpentries-incubator.github.io/good-practices-lesson/instructor/3-documentation.html
• Teach basics on pyproject.toml file
• Teachcff file
• Move local cmd line merge part to 4.1 as a demonstration of command line method. Remove teaching command line merge to main, since this is not a good practice.

4.3 Code Release and Packaging

• Move tagging to 4.3 since it is closely related to packaging
• Update packaging technology to uv

[github-actions]

Thank you!

Thank you for your pull request 😃

🤖 This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}.

If you have files that automatically render output (e.g. R Markdown), then you should check for the following:

• 🎯 correct output
• 🖼️ correct figures
• ❓ new warnings
• ‼️ new errors

Rendered Changes

🔍 Inspect the changes: https://github.com/esciencecenter-digital-skills/python-intermediate-development/compare/md-outputs..md-outputs-PR-8

The following changes were observed in the rendered markdown documents:

 41-code-review.md                           |  21 ++
 42-software-reuse.md                        | 481 +++++++++++++++++-----------
 43-software-release.md                      | 417 ++++++++++++------------
 fig/github-citation-file-rendered.png (new) | Bin 0 -> 81526 bytes
 fig/github-gh-page-settings.png (new)       | Bin 0 -> 96022 bytes
 md5sum.txt                                  |   6 +-
 6 files changed, 538 insertions(+), 387 deletions(-)

What does this mean?

If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible.

This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation.

⏱️ Updated at 2025-11-17 20:19:13 +0000

[rogerkuou]

Hi @sjvrijn @jhidding @fnattino I have updated the Section 4 with the items mentioned in the description. Could you please have a look when you have time? Thanks!

[sjvrijn]

Good stuff! Commented a few fixes and suggestions so far.

[rogerkuou]

Hi @rogerkuou - very nice! Just spotted a couple of typos and left some minor suggestions - feel free to include only what you think makes sense (could also be merged as it is from my side).

thanks @fnattino ! I applied most of your comments. Feel free to have another look!

[jhidding]

Excellent work! I think a reference to the Python Packaging User Guide could be more prominent. It is now mentioned at the end, but maybe also at the beginning as the goto reference on the subject?

As regards the MkDocs Github action exercise suggestion, I think it could be nice to demo, but as an exercise would overload the amount of things people need to learn. There's a lot that comes together there, and no new concepts being tested.

[fnattino]

Looks great @rogerkuou !

[rogerkuou]

Excellent work! I think a reference to the Python Packaging User Guide could be more prominent. It is now mentioned at the end, but maybe also at the beginning as the goto reference on the subject?

As regards the MkDocs Github action exercise suggestion, I think it could be nice to demo, but as an exercise would overload the amount of things people need to learn. There's a lot that comes together there, and no new concepts being tested.

Thanks! I added a callout session metioning this guide at the begining.