miriamkw/GluPredKit

Need to finish making the whole thing installable from scratch with pip

Closed this issue · 2 comments

Will make adoption WAY easier if in the readme we can just say

installation

pip install glupredkit or pip install git+git://github.com/miriamkw/GluPredKit

This involves a few steps

  • make sure setup.py includes all aspects of installation and it works
  • create a pyproject.toml as per https://packaging.python.org/tutorials/packaging-projects/ that includes authors and admin stuff
  • (optional) create an account on https://pypi.org, give access to whoever is an admin for project
  • (optional) upload the code to pypi.org (this can be done in an automated way via GitHub actions, or manually from the command line)

Basic tutorial: https://packaging.python.org/tutorials/packaging-projects/ that includes these steps.

We should make sure it works via pip install glupredkit as well as pip install git+git://github.com/miriamkw/GluPredKit, probably w/ initial emphasis in the second one, since that doesnt require doing any uploads to pypi. People will use this both to gain access to the framework within python and from the command line. So python -m glupredkit <command> will become glupredkit <command>.

For that last step part of the install we have to modify .bashrc or $PATH on the install machine such that glupredkit becomes an executable command. A couple ways of doing this. We might want to just copy the way a library we like does it.

  • Fix redundancy in setup.py / install.sh. Make sure setup.py calls install.sh if necessary.