question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

docs: Encourage `pipx` more strongly in installation guide

See original GitHub issue

I love the new installation guide from @sbalnojan . However, one thing we lost in the transition to the new format was the prioritization of pipx as the preferred installation method - and the instructions to leverage virtual environments if pip is used directly.

  1. I would suggest we change the order of the tabs from [1: pip, 2: docker, 3: pipx] to instead use: [1: pipx, 2: pip, 3: docker]. People who want to do a ‘quick test’ and don’t want to install pipx can still just jump over to the pip tab, and they can ignore the warnings/recommendations, but then if they do run into version conflicts, they remember ignoring the warnings and they know to come back and run it in one of the recommended methods.

  2. The pipx section links to the pipx homepage, but it could also be helpful to link to the ‘how to install pipx’ content directly here: https://docs.meltano.com/guide/installation-guide#install-pipx

  3. The pip section also currently suggests a simple installation, which on its own is very likely to lead to version conflicts. I think we should definitely recommend virtual environments on the pip tab, ideally with a warning about version conflicts, suggesting pip+virtualenv or pipx as the recommended path to avoid conflicts with other installed tools and libraries. To avoid blowing up the page with virtualenv explanation and instructions there on the pip tab, I think we could just add something like this with links to content off the page:

Warning: We strongly recommend you use pipx for installation. If you choose to use pip directly, we recommend creating a dedicated virtual environment to avoid conflicts with other installed software. Learn more here.

cc @tayloramurphy

Issue Analytics

  • State:open
  • Created a year ago
  • Comments:6 (2 by maintainers)

github_iconTop GitHub Comments

1reaction
sbalnojancommented, Oct 17, 2022

@aaronsteers Ok there’s the rub. I was assuming a very different profile. Then we do need to change something, not sure yet how.

My gut feeling would be to then indeed push the pipx version, simply because teaching someone to handle venvs is hard, and would break the flow here. Better to use pipx then and simply “get it to work”, while also putting a clear disclaimer on top (“if you know how to handle venvs, just go ahead and do X; If not, here’s the easy way: …”).

That would still keep the discussion of venvs out of the quick install as well as most of the indepth install content.

1reaction
tayloramurphycommented, Oct 13, 2022

@aaronsteers I think that makes sense. Sven was prioritizing speed of install generally, but if that comes at the expense of some downstream problems it may be worth taking a moment to recommend pipx. @sbalnojan thoughts?

Read more comments on GitHub >

github_iconTop Results From Across the Web

Docs - pipx
Virtual Environments will be installed to $PIPX_HOME/venvs. ... environment Print a list of variables used in pipx.constants. completions Print instructions ...
Read more >
nprintml/README.md at main - GitHub
For a high-level overview, installation instructions, and detailed usage ... as pipx is strongly encouraged. pipx will ensure that nPrintML is installed ......
Read more >
pipenv Documentation - Read the Docs
Strongly encourage the use of the latest versions of dependencies to minimize ... More detailed installation instructions can be found in the Installing...
Read more >
Introduction | Documentation | Poetry - Python dependency ...
See the advanced installation instructions to use a preview or alternate version of Poetry. With the official installer.
Read more >
Useful Flake8 Plugins for Python Linting - DEV Community ‍ ‍
However, I strongly recommend installing Flake8 (or any Python packages) in a ... You can also use pipx to install Flake8 plugins as...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found