-
Notifications
You must be signed in to change notification settings - Fork 65
Description
Improve Charlene's package (#45) 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 and a local copy from Charlene's repository)
-
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 Use CI to run the tests for youย #21. -
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 pull request to Charlene's repository mentioning this issue (by including the text
Addresses UCL-COMP0233-22-23/RSE-Classwork#46in the pull request description), remember to mention your team members too! (with@github_username) -
๐ Congratulations, you've created an awesome research software Python package! ๐๐๐
Sample solution:
UCL-COMP0233-2022-2023/sagittal_average#4 and (UCL-COMP0233-2022-2023/sagittal_average#5 for the automation of step 4)