Improve Charlene's package (#39) even further by adding basic information, a documentation website and the config to run the tests automatically on Github Actions.
Choose who in your team is writing now! (make sure you've got a fork, a local copy from Charlene's repository and a new branch)
Write three files that will make this library sharable, citable and descriptive.
Share your solution even if it's a work-in-progress as a (draft) pull request to Charlene's repository mentioning this issue (by including the text Addresses UCL-COMP0233-23-24/RSE-Classwork#40 in the pull request description), remember to mention your team members too! (with @github_username)
🎉 Congratulations, you've created an awesome research software Python package! 👏👏👏
Improve Charlene's package (#39) even further by adding basic information, a documentation website and the config to run the tests automatically on Github Actions.
Choose who in your team is writing now! (make sure you've got a fork, a local copy from Charlene's repository and a new branch)
Write three files that will make this library sharable, citable and descriptive.
Create a
.github/workflows/pytest.ymlfile to run the test automatically each time something it's pushed to the repository (See also solutions to the exercise #19).Optional: As we did last week, generate a documentation website using
sphinx. (Using thegithubpagessphinx extension and pushing the build directory into agh-pagesbranch will show you the documentation in the repository's website)Share your solution even if it's a work-in-progress as a (draft) pull request to Charlene's repository mentioning this issue (by including the text
Addresses UCL-COMP0233-23-24/RSE-Classwork#40in the pull request description), remember to mention your team members too! (with@github_username)🎉 Congratulations, you've created an awesome research software Python package! 👏👏👏