search

UCL-COMP0233-2022-2023 / RSE-Classwork

11 stars 67 forks source link

Creating a 🐍📦 with an entry point #45

Open dpshelio opened 2 years ago

dpshelio commented 2 years ago

Help Charlene run a command in her latest package (#44) from anywhere. You can do so by adding an entry point following the instructions below.

  1. Choose who in your team is writing now! (make sure you've pulled from your colleague's fork!)

  2. Move the if __name__ == "__main__": block to its own file (e.g., command.py) and add it as entry point to setup.py called "sagittal_average_run" (or to setup.cfg).

  3. Add the dependencies of this library as requirements to setup.py or setup.cfg.

  4. Try to install it by running pip install -e . where the setup.py (or setup.cfg)is.

  5. Go to a different directory, run python -c "import sagittal_average" and see whether the installation worked.

  6. Check you can use the entry point from anywhere, by calling sagittal_average_run <path/to/input/csv> from the different directory.

  7. 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#45 in the pull request description), remember to mention your team members too! (with @github_username)

Sample solution: UCL-COMP0233-22-23/sagittal_average#4