Skip to content
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

Creating a πŸπŸ“¦ with β„Ή, πŸ‘· and πŸ“š #46

Open
dpshelio opened this issue Nov 23, 2022 · 0 comments
Open

Creating a πŸπŸ“¦ with β„Ή, πŸ‘· and πŸ“š #46

dpshelio opened this issue Nov 23, 2022 · 0 comments
Labels
week07 Creating packages

Comments

@dpshelio
Copy link
Contributor

dpshelio commented Nov 23, 2022

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.

  1. Choose who in your team is writing now! (make sure you've got a fork and a local copy from Charlene's repository)

  2. Write three files that will make this library sharable, citable and descriptive.

  3. Create a .github/workflows/pytest.yml file 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.

  4. Optional: As we did last week, generate a documentation website using sphinx. (Using the githubpages sphinx extension and pushing the build directory into a gh-pages branch will show you the documentation in the repository's website)

  5. 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#46 in the pull request description), remember to mention your team members too! (with @github_username)

  6. πŸŽ‰ 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)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
week07 Creating packages
Projects
None yet
Development

No branches or pull requests

1 participant