Skip to content

Creating a ๐Ÿ๐Ÿ“ฆ with โ„น, ๐Ÿ‘ท and ๐Ÿ“šย #46

@dpshelio

Description

@dpshelio

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)

Metadata

Metadata

Assignees

No one assigned

    Labels

    week07Creating packages

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions