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

Documentation improvement suggestion: Add a brief note about how to install PyPy, or link to a list of available Python distributions from the Readme #2953

Open
13 tasks done
ijustlovemath opened this issue Apr 29, 2024 · 5 comments

Comments

@ijustlovemath
Copy link

ijustlovemath commented Apr 29, 2024

Too many issues will kill our team's development velocity, drastically.
Make sure you have checked all steps below.

Prerequisite

  • Make sure your problem is not listed in the common build problems.
  • Make sure no duplicated issue has already been reported in the pyenv issues. You should look for closed issues, too.
  • Make sure you are not asking us to help solving your specific issue.
    • GitHub issues is opened mainly for development purposes. If you want to ask someone to help solving your problem, go to some community site like Gitter, StackOverflow, etc.
  • Make sure your problem is not derived from packaging (e.g. Homebrew).
    • Please refer to the package documentation for the installation issues, etc.
  • Make sure your problem is not derived from plugins.
    • This repository is maintaining pyenv and the default python-build plugin only. Please refrain from reporting issues of other plugins here.

Description

  • Platform information (e.g. Ubuntu Linux 16.04):
  • OS architecture (e.g. amd64):
  • pyenv version:
  • Python version:
  • C Compiler information (e.g. gcc 7.3):
  • Please attach the debug trace of the failing command as a gist:
    • Run env PYENV_DEBUG=1 <faulty command> 2>&1 | tee trace.log and attach trace.log. E.g. if you have a problem with installing Python, run env PYENV_DEBUG=1 pyenv install -v <version> 2>&1 | tee trace.log (note the -v option to pyenv install).
  • If you have a problem with installing Python, please also attach config.log from the build directory
    • The build directory is reported after the "BUILD FAILED" message and is usually under /tmp.
  • If the build succeeds but the problem is still with the build process (e.g. the resulting Python is missing a feature), please attach
    • the debug trace from reinstalling the faulty version with env PYENV_DEBUG=1 pyenv install -f -k -v <version> 2>&1 | tee trace.log
    • config.log from the build directory. When using pyenv install with -k as per above, the build directory will be under $PYENV_ROOT/sources.

I was trying to figure out how to install a PyPy version of Python, and found this tidbit in pyenv-install: https://github.com/pyenv/pyenv/blob/master/plugins/python-build/bin/pyenv-install#L218

The documentation about "Installing additional versions" doesn't show which versions are available before I install the tool, which would be nice to see for future users. Even something as simple as a text file output during CI / linked into the release package. If you're open to that I'd be happy to submit a PR.

Keep it up, love this project!

@native-api
Copy link
Member

https://github.com/pyenv/pyenv?tab=readme-ov-file#install-additional-python-versions :

To install additional Python versions, use pyenv install.

For example, to download and install Python 3.10.4, run:

pyenv install 3.10.4

Running pyenv install -l gives the list of all available versions.

Not sure what's unclear

@ijustlovemath
Copy link
Author

If I wanted to see which versions/distributions were available before installing pyenv, it would be nice to have a list somewhere

@native-api
Copy link
Member

It's the list of scripts at https://github.com/pyenv/pyenv/tree/master/plugins/python-build/share/python-build .

Why do you need that information? Pyenv is supposed to have all releases.

@ijustlovemath
Copy link
Author

ijustlovemath commented May 1, 2024

Thats exactly what I was looking for! I didnt know if pyenv supported the Python I wanted to use, and always take "we support everything" with a grain of salt. Would you be open to a Readme PR linking to this list? Under the "Installing additional Python versions" section?

@native-api
Copy link
Member

Would you be open to a Readme PR linking to this list?

Sure, why not.

But does that really belong in the "Installing additional Python versions" section? It's more of an ad for the product -- so it should probably go into the intro.

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

No branches or pull requests

2 participants