https://github.com/aiguofer/pyenv-version-alias

Pyenv plugin to add an alias to your global pyenv version and individual .python-version
https://github.com/aiguofer/pyenv-version-alias

Last synced: 30 days ago
JSON representation

Pyenv plugin to add an alias to your global pyenv version and individual .python-version

• Host: GitHub
• URL: https://github.com/aiguofer/pyenv-version-alias
• Owner: aiguofer
• License: mit
• Created: 2019-07-05T04:47:36.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-07-12T00:55:40.000Z (over 5 years ago)
• Last Synced: 2024-08-04T02:07:48.783Z (3 months ago)
• Language: Shell
• Size: 12.7 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-env - pyenv-version-alias

README

        
# pyenv-version-alias

Pyenv plugin to add an alias to your global pyenv version and individual .python-version

This is useful when you use multiple versions and/or virtualenvs within a pyenv version, and you want to display a more readable string in tools that display your pyenv version.

For example, if you had your global version set as:

~/.pyenv/version

```

default3

default2

3.5.7

3.6.8

```

Most tools that display this would use `pyenv version-name` which would display `default3:default2:3.5.7:3.6.8`. Using `pyenv version-alias` would display `global`.

Alternatively, if you had a project like this:

~/myproject/.python-version

```

module_virtualenv1

module_virtualenv2

module_virtualenv3

```

Youl could do `pyenv version-alias myproject`, then any time you call `pyenv version-alias` it would return `myproject`

## Installation

```shell

$ git clone https://github.com/aiguofer/pyenv-version-alias $(pyenv root)/plugins/pyenv-version-alias

```

## Usage

To set a version alias (this will create a `.python-version-alias` file in the same dir as your `.python-version`):

```shell

$ pyenv version-alias 

```

To fetch the current alias (this will return `global` for the global version):

```shell

$ pyenv version-alias

```

When using `$PYENV_VERSION` env var, you can't use the normal set method. However, you can create a `$PYENV_VERSION_ALIAS` env var with the alias you want.

## Integrating it into your toolchain

For [powerlevel9k](https://github.com/bhilburn/powerlevel9k), just add this to your `~/.zshrc` (after loading the theme, since you're overriding the function):

```shell

prompt_pyenv() {

    local pyenv_version_name="$(pyenv version-alias)"

    if [[ "${pyenv_version_name}" != "global" || "${POWERLEVEL9K_PYENV_PROMPT_ALWAYS_SHOW}" == "true" ]]; then

        "$1_prompt_segment" "$0" "$2" "blue" "$DEFAULT_COLOR" "$pyenv_version_name" 'PYTHON_ICON'

    fi

}

```

For [powerlevel10k](https://github.com/romkatv/powerlevel10k) it's slightly different:

```shell

prompt_pyenv() {

    local v=$(pyenv version-alias)

    if [[ "${v}" != "global" || "${POWERLEVEL9K_PYENV_PROMPT_ALWAYS_SHOW}" == "true" ]]; then

        "$1_prompt_segment" "$0" "$2" "blue" "$DEFAULT_COLOR" 'PYTHON_ICON' 0 '' "${v//\%/%%}"

    fi

}

```

For Emacs, you can use https://github.com/aiguofer/pyenv.el and enable aliases with

```lisp

(setq pyenv-use-alias 't)

```