GatorEducator/GatorMiner

Deployment of the package

Opened this issue · 0 comments

Currently, the only way to install and use GatorMiner is through Github by cloning the repository. Users need to further configure their local environment in order to set up the web interface and so on. It would be really convenient if GatorMiner could be installed through a pip install command, namely, the PyPI.

The installation command could be like: pip install gatorminer, and through another execution command in the terminal, such as gatorminer.

There are multiple ways to conduct a publish and deployment of a python project, one easy approach that worth exploring is through poetry. This would also simplify the dependency management in the current repository.

A couple of other things to bear in mind:

  • how to automate the continuous deployment of the project once it is published
  • other ways of deployment such as Github Release
  • possible deployment on cloud through a Docker container, where users do not need to start up the program locally
  • whether to further support pipenv once poetry migration is completed
  • documentation update

Useful resources:
https://realpython.com/pypi-publish-python-package/
https://python-poetry.org
https://github.com/yhino/pipenv-poetry-migrate