A pyenv plugin to enable a more friendly multi-user environment. This plugin will alter the code of pyenv where it looks for the shims directory. By default, the shims directory is setup under $PYENV_ROOT/shims, when multiple users are using the same pyenv instance there could be collisions with the changing of shims relative to each environment being used. At times the lock in this directory may fail to be unlocked and prevent others from making changes.
This plugin will solve this by having the base pyenv code look for a custom directory specified by the environment variable PYENV_LOCAL_SHIM. This can be setup under an individuals home directory or other personal directory, which will prevent the above mentioned issues.
Installing pyenv-multiuser as a pyenv plugin will give access to the pyenv multiuser command.
git clone https://github.com/vertify-mldev1/pyenv-multiuser.git $(pyenv root)/plugins/pyenv-multiuser
After installed, you should run pyenv multiuser setup to setup the pyenv to look for the PYENV_LOCAL_SHIM environment variable. Any users that may want to use can run pyenv multiuser init to setup their local shim directory settings.
A command is provided within the pyenv-multiuser plugin to uninstall the plugin. This will restore the original files that were change in the pyenv install and then remove the plugin from the pyenv install.
pyenv multiuser uninstall
This will ask for confirmation that uninstallation is desired before proceeding.
Initial setup is done via pyenv multiuser setup
pyenv multiuser setup
An individual user can setup their personalized shims directory environment variable using pyenv multiuser init
pyenv multiuser init [PATH]
This is command allows the user to setup the local shim directory. This will automatically add the appropriate export command to their shell rc file.
- A bash shell will add the export to
$HOME/.bashrc. - A zsh shell will add the export to
$HOME/.zshrc. - All other shells will add the export to
$HOME/.profile. It should be noted that there are shells that will ignore.profile, such as csh and ksh by default.
To ensure that the shims work correctly, your profile should look similar to this:
# Example Profile Setup
export PYENV_LOCAL_SHIM="$HOME/.pyenv_local_shim"
export PATH="$PYENV_LOCAL_SHIM:$PYENV_ROOT/bin:$PATH"
eval "$(pyenv virtualenv-init -)"You should refer to the PyEnv Installation and adjust to include the above.
The pyenv multiuser update command is a bit of a wrapper around the pyenv-update command. Since this plugin makes changes to the base code of pyenv, it is required to restore the original versions of those files before performing updates. This will restore the unaltered files, perform the update, and finally re-setup the multiuser changes.
$ pyenv multiuser update
The pyenv multiuser uninstall command will uninstall the plugin from your pyenv install. It restores the normal pyenv files that it modified prior to uninstalling to ensure that your pyenv install will still function.
$ pyenv multiuser uninstall
-
Used to initialize the multiuser plugin. This only needs to be done once per pyenv install.
$ pyenv multiuser setup
-
Initialize the shim path for the individual user
-
Can specify a custom path for the shim location. Defaults to $HOME/.pyenv_local_shim
$ pyenv multiuser init
-
Display the setup status of the plugin
$ pyenv multiuser status
setup.true file ... Found
setup date ... Tue May 17 13:59:27 CDT 2022
back up file count ... 11
file list:
[1]: /home/user/.pyenv/plugins/pyenv-multiuser/backup/__home__user__.pyenv__libexec__pyenv-init
[2]: /home/user/.pyenv/plugins/pyenv-multiuser/backup/__home__user__.pyenv__libexec__pyenv-rehash
[3]: /home/user/.pyenv/plugins/pyenv-multiuser/backup/__home__user__.pyenv__libexec__pyenv-shims
[4]: /home/user/.pyenv/plugins/pyenv-multiuser/backup/__home__user__.pyenv__libexec__pyenv-which
[5]: /home/user/.pyenv/plugins/pyenv-multiuser/backup/__home__user__.pyenv__plugins__pyenv-virtualenv__bin__pyenv-virtualenv
[6]: /home/user/.pyenv/plugins/pyenv-multiuser/backup/__home__user__.pyenv__plugins__pyenv-which-ext__etc__pyenv.d__which__lookup_from_path.bash
[7]: /home/user/.pyenv/plugins/pyenv-multiuser/backup/__home__user__.pyenv__test__init.bats
[8]: /home/user/.pyenv/plugins/pyenv-multiuser/backup/__home__user__.pyenv__test__rehash.bats
[9]: /home/user/.pyenv/plugins/pyenv-multiuser/backup/__home__user__.pyenv__test__shims.bats
[10]: /home/user/.pyenv/plugins/pyenv-multiuser/backup/__home__user__.pyenv__test__test_helper.bash
[11]: /home/user/.pyenv/plugins/pyenv-multiuser/backup/__home__user__.pyenv__test__which.bats
-
Restores the backed up files for the standard pyenv install and then updates using the pyenv-update plugin. After the update has completed, the multiuser changes are reapplied.
$ pyenv multiuser update
-
Uninstall the multiuser plugin and restore the standard pyenv files.
$ pyenv multiuser uninstall
- Added
multiuser statuscommand to display list of backed up files and display if setup was run and the date it was setup - Removed the use of
$(pyenv root)in favor of using the PYENV_ROOT variable
- fix issue where after
multiuser updatewas run, the multiuser setup was not run to put the altered code back in place
- hotfixes
- logic to replace the 'setup.true' marker file after an update is run
- add check for PYENV_BASE environment variable being set and set to PYENV_ROOT if it is not set
- remove backup directory from repository
- add logic to create backup directory during the
pyenv multiuser setupcommand execution
- general code clean up
- if-statement conventions
- github
- create new workflow to run for all branches
- update setup information
- bug fixes related to backup creation and restoration
- CI pipeline setup
- user init function creates shims directory
- user init can take in custom directory as parameter
pyenv multiuser init <CUSTOM_PATH>
- add uninstall command
- add check to update function to look for the pyenv-update plugin
- Initial version