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

Conda-specific compatibility note in documentation #1862

Open
acdha opened this issue Mar 28, 2018 · 9 comments
Open

Conda-specific compatibility note in documentation #1862

acdha opened this issue Mar 28, 2018 · 9 comments
Labels
good first issue Issues suitable as a newcomer to get familiar with Pipenv! Type: Documentation 📖 This issue relates to documentation of pipenv.

Comments

@acdha
Copy link
Contributor

acdha commented Mar 28, 2018

I was attempting to help some visiting astronomers start using pipenv and ran into two problems with the instructions:

https://github.com/pypa/pipenv/blob/master/docs/advanced.rst#-pipenv-and-conda

The easy problem was that /path/to/anaconda… will not work if you simply copy and paste it but it's possible to miss that because while it prints “The path /foo/bar/baaz (from --python=/foo/bar/baaz) does not exist” that is buried under a lengthy traceback with the last thing people see being “TypeError: 'NoneType' object is not subscriptable”. Do you think it'd be worth a pull-request which would just end with the first message?

The more time-consuming problem was actually a Conda problem where the virtualenv creation failed with an error message early in the startup about being unable to import _io in the tempfile stdlib module, which was fixed at some point but hadn't been updated on their system. conda update python virtualenv fixed the problem but wasn't the first thing they were jumping to try. Should I contribute a brief note for the docs suggesting this more obviously?

@techalchemy
Copy link
Member

@acdha that would be greatly appreciated -- that particular TypeError pretty much always means we couldn't find whatever your executable was, the additional information is not very helpful I would agree.

As far as the conda integration, I am not too familiar with the typical conda workflow but if you think this is a common issue I'd probably track it in the normal conda integration notes, whereas if you think it's less common it might belong in the troubleshooting documentation.

Thanks for letting us know about this and for helping out! These kinds of things always fall to the wayside but are incredibly important

@acdha
Copy link
Contributor Author

acdha commented Mar 28, 2018

I'll work on a pull request for the missing executables.

Re:Conda docs, I'm not sure I'd say it's common — I think it's the kind of situation where most people don't hit it but the ones who do can get really confused trying to search for a solution. I'll take a stab at proposing a doc update.

acdha added a commit to acdha/pipenv that referenced this issue Mar 28, 2018
This makes it easier for someone to realize when they
have provided an invalid Python path without missing that message in the virtualenv traceback.
acdha added a commit to acdha/pipenv that referenced this issue Mar 28, 2018
This makes it easier for someone to realize when they have provided an
invalid Python path without missing that message due to the sizable
virtualenv traceback which follows it. I first encountered this when
someone copy-and-pasted the example from the Conda documentation which
has `--python=/path/to/anaconda/python`.

See pypa#1862
acdha added a commit to acdha/pipenv that referenced this issue Mar 28, 2018
This makes it easier for someone to realize when they have provided an
invalid Python path without missing that message due to the sizable
virtualenv traceback which follows it. I first encountered this when
someone copy-and-pasted the example from the Conda documentation which
has `--python=/path/to/anaconda/python`.

See pypa#1862
@acdha
Copy link
Contributor Author

acdha commented Mar 28, 2018

As an aside, it feels like the @click.option stack in cli.py has too many instances where common options are repeated. Is there a plan to split those out or should I take a stab at it?

@techalchemy
Copy link
Member

@acdha the current plan has been focused on fixing testing infrastructure so I'm pretty sure this hasn't made it to anyone's priority list. I am very far from a click expert so my involvement with the stack in cli.py is basically minimal, if you're willing and able to consolidate we'd appreciate it for sure

acdha added a commit to acdha/pipenv that referenced this issue Apr 18, 2018
This makes it easier for someone to realize when they have provided an
invalid Python path without missing that message due to the sizable
virtualenv traceback which follows it. I first encountered this when
someone copy-and-pasted the example from the Conda documentation which
has `--python=/path/to/anaconda/python`.

See pypa#1862
@uranusjr uranusjr added Type: Documentation 📖 This issue relates to documentation of pipenv. good first issue Issues suitable as a newcomer to get familiar with Pipenv! labels Jun 6, 2018
@uranusjr uranusjr changed the title Is it worth a Conda-specific compatibility note? Conda-specific compatibility note in documentation Jun 6, 2018
@Karthik-PM
Copy link

can i help with this ?

@matteius
Copy link
Member

@Karthik-PM That would be great!

@azizHakim
Copy link

azizHakim commented Mar 16, 2023

@Karthik-PM are you still working on it? If not I can help

@matteius
Copy link
Member

@azizHakim Please be aware that the documentation is about to get major changes when this gets merged tomorrow: #5621

Will greatly appreciate your help, but perhaps defer until after then :-)

@azizHakim
Copy link

@matteius sure, thanks for the heads up.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Issues suitable as a newcomer to get familiar with Pipenv! Type: Documentation 📖 This issue relates to documentation of pipenv.
Projects
None yet
Development

No branches or pull requests

6 participants