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

Recommend pipx to install offlinedatasci #124

Closed
abhidg opened this issue May 3, 2024 · 3 comments · Fixed by #137
Closed

Recommend pipx to install offlinedatasci #124

abhidg opened this issue May 3, 2024 · 3 comments · Fixed by #137

Comments

@abhidg
Copy link
Contributor

abhidg commented May 3, 2024

Installing pipx (https://pipx.pypa.io) will be an additional step, but afterwards installing and updating offlinedatasci becomes simpler. Using pipx also ensures best practice such as installing binaries into a virtual environment.

Alternatives

  • Keep using pip as now
  • Give instructions to install offlinedatasci into a virtual environment

This should also bypass the long path error on Windows #119

@ethanwhite
Copy link
Collaborator

Is pipx appropriate since we also include a Python interface?

pipx replaces a subset of pip's functionality; it lets you install cli applications but NOT libraries that you import in your code.

https://pipx.pypa.io/latest/comparisons/

Given this I don't think this can be the only or primary recommendation, but I'd be happy to add a second install description that will work but only if using the CLI.

Note that #119 has been solved so pip now works for all OSs.

@ethanwhite ethanwhite added the Awaiting author contribution Waiting on the issue author to do something before proceeding label May 20, 2024
@github-actions github-actions bot removed the Awaiting author contribution Waiting on the issue author to do something before proceeding label May 20, 2024
@abhidg
Copy link
Contributor Author

abhidg commented May 20, 2024 via email

@ethanwhite
Copy link
Collaborator

Thanks! Just opened a PR and requested a review. I left pip first since it is the default and doesn't require installing a package that will be new to many folks, but I restructured things so that pipx is immediately after and states that we recommend it for CLI install.s

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants