UCL-MPHY0021-21-22 / RSE-Classwork

7 stars 73 forks source link

Creating a šŸšŸ“¦ #36

Open dpshelio opened 3 years ago

dpshelio commented 3 years ago

Help Charlene to create her repository into a package (remember to commit after each step).

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

  2. Add a .gitignore file to the repository to avoid adding artefacts created by python or your text editor. You can use gitignore.io to generate a file for your needs.

  3. Modify the repository directory structure to make sagittal_average as an installable package (don't forget to add empty __init__.py files, but there is no need to add the .md files (yet!)).

  4. Add a setup.py file with the information needed.

  5. Try to install it by running pip install -e . from the command line, in the filesystem location where the setup.py is.

  6. Share your solution as a pull request to Charlene's repository mentioning this issue (by including the text Addresses UCL-MPHY0021-21-22/RSE-Classwork#36 in the pull request description), remember to mention your team members too! (with @github_username)

  7. Congratulations, you've created a Python package! Now, let's see what can be improved about it in the subsequent issues!