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

Deployment of the package #31

Open
enpuyou opened this issue Feb 25, 2021 · 0 comments
Open

Deployment of the package #31

enpuyou opened this issue Feb 25, 2021 · 0 comments
Assignees
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

Comments

@enpuyou
Copy link
Contributor

enpuyou commented Feb 25, 2021

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

@enpuyou enpuyou added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed question Further information is requested labels Feb 25, 2021
@enpuyou enpuyou self-assigned this Feb 25, 2021
@WesleyL30 WesleyL30 added Team 1 Team 1 is working on this issue Team 2 Wes, Gabe, Nolan, Ryan and removed Team 1 Team 1 is working on this issue labels Mar 31, 2021
@enpuyou enpuyou removed their assignment Mar 31, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Projects
None yet
Development

No branches or pull requests

5 participants