search

UCL-COMP0233-24-25 / RSE-Classwork

6 stars 85 forks source link

Creating a 🐍📦 with ℹ, 👷 and 📚 #34

Open dpshelio opened 1 week ago

dpshelio commented 1 week ago

Improve Charlene's package (#33) 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, a local copy from Charlene's repository and a new branch)

  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 #14).

  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. Optional: Add a new get_started page under a how_to directory that says how to install the library.

  6. 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-24-25/RSE-Classwork#34 in the pull request description), remember to mention your team members too! (with @github_username)

  7. 🎉 Congratulations, you've created an awesome research software Python package! 👏👏👏

Sample solution Sample solution (optional: basic docs) Sample solution (optional: how to page)

VanyMo commented 1 week ago

Image