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.

Sign up for GitHub

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

Jump to bottom

Add vanity CLI #56

Open
cthoyt opened this issue Jan 15, 2021 · 4 comments · May be fixed by #57
Open

Add vanity CLI #56

cthoyt opened this issue Jan 15, 2021 · 4 comments · May be fixed by #57
Assignees
@callahantiff
Labels
coding enhancement New feature or request

Comments

@cthoyt
Copy link

cthoyt commented Jan 15, 2021

If the main.py were included in the source code hierarchy, the python entrypoints in setuptools could be used ot make a vanity cli called omop2obo along with installation of the code. This would make it much more extensible for others since they wouldn't have to know where the code itself was. Would you be willing to accept a PR for this?
@cthoyt cthoyt added the coding label Jan 15, 2021
@callahantiff
Copy link
Owner

Hey @cthoyt! The functionality you are describing sounds like a great. Thanks for offering to do this, I'd be happy to review a PR 😄

@callahantiff callahantiff added the enhancement New feature or request label Jan 17, 2021
cthoyt added a commit to cthoyt-forks-and-packages/OMOP2OBO that referenced this issue Jan 17, 2021
@cthoyt
Move main.py into package and add vanity CLI
23cf328 
Closes callahantiff#56
@cthoyt cthoyt linked a pull request Jan 17, 2021 that will close this issue
Open
@joeflack4
Copy link

I have some experience with CLIs, as well as packaging and releasing stuff on PyPi. I don't know how much extra bandwidth I have, but this is something I could possibly help with.

@cthoyt What is a vanity CLI? Is that just a figure of speech, or a particular type of CLI?

@cthoyt
Copy link
Author

cthoyt commented Mar 2, 2022 •
edited
Loading

This is when you use Python entrypoints to make a nice CLI command available in the shell like obo2omop - this is not a standard phrase but I think it's appropriate since it wraps what would otherwise be python -m obo2omop. Please note I already sent a PR that solves this issue, linked just above your comment (or here #57)

more info on how I think about this on my blog: https://cthoyt.com/2020/06/11/click.html

@joeflack4
Copy link

Ah ok, that's pretty cool. I'll give that a read.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@callahantiff callahantiff

Labels
coding enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Move main.py into package and add vanity CLI cthoyt-forks-and-packages/OMOP2OBO
3 participants
@cthoyt @callahantiff @joeflack4