v1.1.0 (#2)

Author: connesy

.github/workflows/run_tests.yml

@@ -13,11 +13,10 @@ permissions:
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
-
     steps:
     - uses: actions/checkout@v3
+
     - name: Set up Python 3.10
       uses: actions/setup-python@v3
       with:
@@ -28,7 +27,7 @@ jobs:
 
     - name: Install dependencies
       run: |
-        python3.10 -m venv .venv --prompt="venv-cli"
+        python3.10 -m venv .venv
         . .venv/bin/activate
         python -m pip install --require-virtualenv --upgrade pip
         python -m pip install --require-virtualenv -r dev-requirements.txt

CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## [v1.1.0](https://github.com/SallingGroup-AI-and-ML/venv-cli/releases/tag/v1.1.0) (2023-08-02)
+
+### New install script
+This release adds an `install.sh` script for easier installation of `venv-cli`. Now it can be installed by simply running
+```console
+$ bash install.sh
+```
+
+For more information on installing and uninstalling, see the updated [README](https://github.com/SallingGroup-AI-and-ML/venv-cli/blob/v1.1.0/README.md)
+
+### Internal changes
+
+* Added functionality to `venv lock`: Since `pip freeze` (which `venv lock` is using under the hood) does not output the `auth`-part of VCS URLs, `venv lock` now includes a fix that tries to read them from a reference `requirements`-file, but **only if they are specified as environment variables** so as not to accidentally expose secrets in version-controlled `.lock`-files.
+
+For more info on this, see `venv lock --help`.
+
 ## [v1.0.2](https://github.com/SallingGroup-AI-and-ML/venv-cli/releases/tag/v1.0.2) (2023-08-02)
 
 * Fixed test that checks the version number follows the required pattern.

README.md

@@ -4,26 +4,33 @@
 
 ## Overview
 `venv-cli` is a CLI tool to help create and manage virtual python environments.
-It uses `pip` and `python -m venv` underneath, and so only requires core python. This alleviates the bootstrapping problem of needing to install a python package using your system python and pip before you are able to create virtual environments.
+It uses `pip` and `python -m venv` underneath, and so only requires core python. This alleviates the bootstrapping problem of needing to install a python package using your system `python` and `pip` before you are able to create virtual environments.
 
-You also don't need `conda`, `pyenv`, `pythonz` etc. to manage your python versions. Just make sure the correct version of python is installed on your system, then reference that specific version when creating the virtual environment, and everything just works. No shims, no path hacks, just the _official_ `python` build.
+You also don't need `conda`, `pyenv`, `pythonz` etc. to manage your python versions. Just make sure the correct version of python is installed on your system, then reference that specific version when creating the virtual environment, and everything just works. No shims, no path hacks, just the official `python` build.
 
 ## Installation
 
-Clone this repository, then add a line to your `~/.bashrc` (or `~/.zshrc`, etc) that sources the `src/venv-cli/venv.sh` file:
-
-```bash
-if [ -f ~/venv-cli/src/venv-cli/venv.sh ]; then
-    . ~/venv-cli/src/venv-cli/venv.sh
-fi
+Clone this repository, then run the `install.sh` script from your favourite shell:
+```console
+$ bash install.sh
 ```
+This will install the `venv` source file, along with an uninstall script, in `/usr/local/share/venv/`, and add a line in the appropriate shell `rc`-file (e.g. `~/.bashrc`) sourcing the `venv` source script.
 
 This makes the `venv` command avaiable in your terminal. To check if it works, restart the terminal and run
 ```console
 $ venv --version
 venv-cli 1.0.0
 ```
 
+The install script also adds command completions for the invoked shell.
+
+# Uninstall
+To uninstall `venv` and remove all files, run the uninstall script at `/usr/local/share/venv/`:
+```console
+$ bash /usr/local/share/venv/uninstall.sh
+```
+The script should be run by the user that ran the install script to correctly remove the sourcing lines from the `rc`-file of that user. However, since it also cleans up the files in `/usr/share/local/venv/`, it will ask for `sudo` access.
+
 ## Usage
 
 To see the help menu, along with a list of available commands, run `venv -h/--help`.
@@ -100,7 +107,7 @@ are equivalent.
 
 The installed packages are then _locked_ into the corresponding `.lock`-file, e.g. running `venv install dev-requirements.txt` will lock those installed packages into `dev-requirements.lock`.
 
-Installing packages this way makes sure that they are "tracked", since installing them with `pip install` will keep no record of which packages have been installed in the environment, making it difficult to reproduce later on.
+Installing packages this way makes sure that they are tracked, since installing them with `pip install` will keep no record of which packages have been installed in the environment, making it difficult to reproduce later on.
 
 ### Development packages
 If you have both production and development package requirements, keep them in separate requirements-files, e.g. `requirements.txt` for production and `dev-requirements.txt` for development. An example of these could be:

install.sh

@@ -0,0 +1,59 @@
+_src_dir="${PWD}/src/venv-cli"
+_install_dir="/usr/local/share/venv"
+
+set -e
+
+install_common() {
+  local rcfile="$1"
+  local completion_file="$2"
+  local completion_target="$3"
+
+  set -x
+  sudo mkdir -p /usr/local/share/venv
+  sudo cp "${_src_dir}/venv.sh" "${_install_dir}/venv"
+  sudo cp "${_src_dir}/uninstall.sh" "${_install_dir}/uninstall.sh"
+
+  if [ -n "${completion_file}" ]; then
+    sudo cp "${completion_file}" "${completion_target}"
+  fi
+
+  # Append line to the shell config file to source the script
+  echo -e "\n# Source function script for 'venv' command" >> "${rcfile}"
+  echo ". ${_install_dir}/venv" >> "${rcfile}"
+  { set +x; } 2>/dev/null
+}
+
+install_bash() {
+  local rcfile="${HOME}/.bashrc"
+  local completion_file="${_src_dir}/completions/bash/venv_completion.sh"
+  local completion_target="/usr/share/bash-completion/completions/venv"
+  PS4="\000"  # Remove '++' from beginning of lines while printing commands
+
+  install_common "${rcfile}" "${completion_file}" "${completion_target}"
+}
+
+install_zsh() {
+  local rcfile="${HOME}/.zshrc"
+  # local completion_file="${_src_dir}/completions/zsh/venv_completion.sh"
+  # local completion_target="/usr/local/share/zsh/site-functions/_venv"
+  echo "Command completions currently not supported for zsh"
+
+  install_common "${rcfile}"
+  echo "fpath+=( ${_install_dir} )" >> "${rcfile}"
+  echo "autoload -Uz venv" >> "${rcfile}"
+}
+
+main() {
+  if [ -n "${ZSH_VERSION}" ]; then
+    install_zsh
+  elif [ "${SHELL}" = "/bin/bash" ]; then
+    install_bash
+  else
+    echo "Current shell is not supported, aborting..."
+    return 1
+  fi
+
+  echo "venv installed"
+}
+
+main

src/venv-cli/completions/bash/venv_completion.sh

@@ -0,0 +1,20 @@
+# bash completion for venv                                -*- shell-script -*-
+
+_venv() {
+    local cur_word prev_word subcommands fill_list
+    cur_word="${COMP_WORDS[COMP_CWORD]}"
+    prev_word="${COMP_WORDS[COMP_CWORD-1]}"
+    subcommands="create activate install lock clear sync deactivate -V --version"
+    command_options="-h --help"
+
+    if [ "${prev_word}" == "venv" ]; then
+        fill_list="${subcommands} ${command_options}"
+    else
+        fill_list="${command_options}"
+    fi
+    COMPREPLY=($(compgen -W "${fill_list}" -- "${cur_word}"))
+}
+
+complete -F _venv venv
+
+# ex: filetype=sh

src/venv-cli/completions/zsh/venv_completion.sh

@@ -0,0 +1,28 @@
+#compdef venv
+
+local curcontext="${curcontext}" state line
+typeset -A opt_args
+
+# List of available options
+local -a subcommands=("create" "activate" "install" "lock" "clear" "sync" "deactivate" "-V" "--version")
+local -a command_options=("-h" "--help")
+local -a all=("${subcommands[@]} ${command_options[@]}")
+
+case "${words}[2]" in
+    "${subcommands}")
+        # Complete the options if the second word matches any of the available options
+        _describe "option" command_options
+        ;;
+    *)
+        case "${words}[1]" in
+            venv)
+                # Complete the base command options if the first word is "venv"
+                _describe "option" all
+                ;;
+            # *)
+            #     # If none of the above matches, complete file paths
+            #     _files
+            #     ;;
+        esac
+        ;;
+esac

src/venv-cli/uninstall.sh

@@ -0,0 +1,53 @@
+_venv_dir="/usr/local/share/venv"
+
+set -e
+PS4="\000"
+
+post() {
+  sudo rm ${_venv_dir}/* || true
+  sudo rm -r "${_venv_dir}" || true
+}
+
+uninstall_common() {
+  local rcfile="$1"
+  local completion_target="$2"
+
+  # Remove the line from shell config that sources the script
+	sed -i "\|.*Source autocompletions for 'venv' command|d" "${HOME}/.bashrc"
+	sed -i "\|\. ${_venv_dir}/venv|d" "${HOME}/.bashrc"
+
+  if [ -f "${completion_target}" ]; then
+    sudo rm "${completion_target}"
+  fi
+}
+
+uninstall_bash() {
+  local rcfile="${HOME}/.bashrc"
+  local completion_target="/usr/share/bash-completion/completions/venv"
+
+  uninstall_common "${rcfile}" "${completion_target}"
+}
+
+uninstall_zsh() {
+  local rcfile="${HOME}/.zshrc"
+  local completion_target="/usr/local/share/zsh/site-functions/_venv"
+
+  uninstall_common "${rcfile}" "${completion_target}"
+  sed -i "\|fpath+=( ${_install_dir} )|d" "${HOME}/.zshrc"
+  sed -i "\|autoload -Uz venv|d" "${HOME}/.zshrc"
+}
+
+main() {
+  if [ -f "${HOME}/.bashrc" ]; then
+    uninstall_bash
+  fi
+
+  if [ -f "${HOME}/.zshrc" ]; then
+    uninstall_zsh
+  fi
+
+  post
+  echo "venv uninstalled"
+}
+
+main