Allow running tool as package or script#7
Open
patcon wants to merge 11 commits intoWelltory:masterfrom
Open
Conversation
patcon
commented
May 11, 2021
| 1. Use an virtualenv or isolation tactic you prefer | ||
| 2. Install as a package | ||
| ``` | ||
| $ pip install git+https://github.com/patcon/Zoom2YouTube.git@packaged#egg=zoom2youtube |
Author
There was a problem hiding this comment.
Merge this before accepting PR :)
Suggested change
| $ pip install git+https://github.com/patcon/Zoom2YouTube.git@packaged#egg=zoom2youtube | |
| $ pip install git+https://github.com/Welltory/Zoom2YouTube.git@master#egg=zoom2youtube |
Open
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Hi! Thank for this!
Previously, this tool was intended to run as a script, but not a python package.
I wanted to use it in another repo that has a suite of Python CLI tools, so it made most sense to install it as a package. This adds enough to get that working :)
Here's what I did:
src/tosrc/zoom2youtube, aligning with Python packaging recommendationsmain(), so that it could be run as a console_scriptpipenv-setupto help manage setup.py deps (incl addingpipenv)Main things to note:
The one opinionated thing I did was add pipenv support, since I prefer to use it for package isolation instead of virtualenv directly. It just generated its pipfile from requirements.txt (requirements.txt could be removed if y'all wanted to go officially all-in with pipenv on this. (I also use
poetrysometimes as pkg manager, but opted not to use this as per reason below)I also added pipenv-setup, to autogenerate the setup.py installed packages based on the pipenv.lock, so there's no need to keep the package spec in sync with requirements/pipfile. (this was the main reason i added pipenv, to make maintenance burden of package+script less)
Curious if you'd be willing to merge this...! Thanks for considering!