-
Notifications
You must be signed in to change notification settings - Fork 1
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.
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
Add new file for python template episode #1
base: main
Are you sure you want to change the base?
Conversation
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:
Rendered Changes🔍 Inspect the changes: https://github.com/SS-NES/SS-NES-lesson/compare/md-outputs..md-outputs-PR-1 The following changes were observed in the rendered markdown documents:
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-02-07 07:51:58 +0000 |
Note from discussion: the python template assumes knowledge of e.g. copier and pipx. Any tool we decide to use in this lesson material should be properly explained! |
episodes/python-template.md
Outdated
|
||
:::::::::::::::::::::::::::::::::::::: questions | ||
|
||
- How can you quickly set up a new Python repository that follows best practices? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If we connect it also to the SMP we can add the question:
How to create a new Python repository that covers your needs and follows best practices
6357989
to
e8769e4
Compare
e8769e4
to
b5c0601
Compare
b5c0601
to
8363e0e
Compare
Co-authored-by: chStaiger <[email protected]>
f83f355
to
b9f9e7e
Compare
:::::::::::::::::::::::: solution | ||
|
||
```bash | ||
copier copy gh:nlesc/python-template path/to/destination |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some word of explanation to the path/to/destination
will make it clearer that it is not a path in the github of the python-template e.g. path/to/your/code/project
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice! No major comments. I like the two exercises that show the usefulness of the yaml files and connect the creation of the repo to the software management plan!
Closes #25
Just a quick outline file for an episode on the python template: