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

Open
dpshelio opened this issue Nov 18, 2024 · 0 comments
Open

Creating a 🐍📦 #31

dpshelio opened this issue Nov 18, 2024 · 0 comments
Labels
week07 Creating packages

Comments

@dpshelio
Copy link
Contributor

dpshelio commented Nov 18, 2024

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. There is no need to add the .md files (yet!).

  4. Add a pyproject.toml file with the information needed.

  5. Make sure you are in a python environment (e.g., comp0233's conda environment) and try to install it by running pip install -e . from the command line, in the filesystem location where the pyproject.toml is.

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

@dpshelio dpshelio added the week07 Creating packages label Nov 18, 2024
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