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 🐍📦 #43

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

Creating a 🐍📦 #43

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

Comments

@dpshelio
Copy link
Contributor

dpshelio commented Nov 23, 2022

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

  1. Choose who in your team is writing 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][lesssons-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 or a setup.cfg with the correct key values

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

  6. Share your solution as a pull request to Charlene's repository mentioning this issue (by including the text Addresses UCL-COMP0233-22-23/RSE-Classwork#43 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!


Sample solution:
UCL-COMP0233-2022-2023/sagittal_average#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