Deployment of the package #31
Labels
documentation
Improvements or additions to documentation
enhancement
New feature or request
help wanted
Extra attention is needed
question
Further information is requested
Team 2
Wes, Gabe, Nolan, Ryan
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 ifGatorMiner
could be installed through apip install
command, namely, the PyPI.The installation command could be like:
pip install gatorminer
, and through another execution command in the terminal, such asgatorminer
.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:
pipenv
oncepoetry
migration is completedUseful resources:
https://realpython.com/pypi-publish-python-package/
https://python-poetry.org
https://github.com/yhino/pipenv-poetry-migrate
The text was updated successfully, but these errors were encountered: