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

jupyter-fileid script needs click #54

Open
frenzymadness opened this issue Dec 14, 2022 · 6 comments
Open

jupyter-fileid script needs click #54

frenzymadness opened this issue Dec 14, 2022 · 6 comments
Labels
bug Something isn't working

Comments

@frenzymadness
Copy link
Contributor

Description

I've installed jupyter-server-fileid from PyPI and it created an executable file bin/jupyter-fileid. Unfortunately, the script does not work because click is not installed by default.

Reproduce

  1. run pip install jupyter-server-fileid
  2. run bin/jupyter-fileid

Expected behavior

I can imagine two possible solutions:

  1. Add click to the standard dependencies. I've calculated the size of a virtualenv where I installed only jupyter-server-fileid and all its dependencies and it has 66 MB. Adding click there adds only one more MB which is not that big difference.
  2. Make it more user-friendly for users. Add try/except to the script and an error message saying that you should install jupyter-server-fileid[cli] or click directly to make it work.
@frenzymadness frenzymadness added the bug Something isn't working label Dec 14, 2022
@welcome
Copy link

welcome bot commented Dec 14, 2022

Thank you for opening your first issue in this project! Engagement like this is essential for open source projects! 🤗

If you haven't done so already, check out Jupyter's Code of Conduct. Also, please try to follow the issue template as it helps other other community members to contribute more effectively.
welcome
You can meet the other Jovyans by joining our Discourse forum. There is also an intro thread there where you can stop by and say Hi! 👋

Welcome to the Jupyter community! 🎉

@dlqqq
Copy link
Collaborator

dlqqq commented Feb 16, 2023

Hm, right now the CLI is mainly intended for developers, which is why we require the explicit [cli] during installation for usage.

#49 will add additional user-facing commands that warrant inclusion of click to the required dependencies. Sadly I haven't had much time to work on that due to a flurry of new responsibilities, but I would be happy to include this change once I return to work on it. 😁

@dlqqq
Copy link
Collaborator

dlqqq commented Feb 16, 2023

Also sorry for the incredibly late response; despite being the creator of this repo, GH defaulted to not notifying me unless explicitly mentioned. I have changed my settings to allow me to be notified and respond more quickly.

@frenzymadness
Copy link
Contributor Author

Hm, right now the CLI is mainly intended for developers, which is why we require the explicit [cli] during installation for usage.

Then it makes sense. Thanks for the explanation. Do you want to keep this issue open for adding the better error message?

@dlqqq
Copy link
Collaborator

dlqqq commented Feb 17, 2023

Do you want to keep this issue open for adding the better error message?

Yup, I left this issue open intentionally. 😁

@dlqqq
Copy link
Collaborator

dlqqq commented Feb 17, 2023

Well, the error message won't be needed if click becomes installed by default after we add user-facing CLI options.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants