Remove 'venv sync' command (#17)

Closes #13

Author: connesy

CHANGELOG.md

@@ -1,6 +1,9 @@
 # Changelog
 
-## [Unreleased](https://github.com/SallingGroup-AI-and-ML/venv-cli/tree/develop)
+## [v2.0.0](https://github.com/SallingGroup-AI-and-ML/venv-cli/tree/release/2.0)
+
+### Major changes
+* `venv sync` has been removed. Use `venv install <requirements>.lock` instead. [#17](https://github.com/SallingGroup-AI-and-ML/venv-cli/pull/17)
 
 ### Minor changes
 * `venv sync` command marked as deprecated with removal planned for `v2.0`. Use `venv install <requirements>.lock` instead. [#14](https://github.com/SallingGroup-AI-and-ML/venv-cli/pull/14)

README.md

@@ -126,19 +126,12 @@ matplotlib
 The `-r requirements.txt` will make sure that installing development requirements also install production requirements.
 
 ## Reproducing environment
-To install a reproducible environment, you need to install from a `.lock`-file, since those have all versions of all requirements locked[^1]. From a clean environment (no packages installed yet), run
+To install a reproducible environment, you need to install from a `.lock`-file, since those have all versions of all requirements locked[^1]:
 ```console
 $ venv install requirements.lock
 ```
 
-If you don't have a clean environment, but still want to recreate the environment as it was when the requirements were locked, you can run
-```console
-$ venv sync requirements.lock
-```
-
-This will first remove all installed packages, then run `venv install requirements.lock`.
-
-**NOTE: Since this command is meant to create a reproducable environment, you cannot `sync` to a `.txt` file; it has to be a `.lock` file.**
+This will first clear the environment of any installed packages, then install the packages and versions specified in `requirements.lock`.
 
 ## Clearing the environment
 If you want to manually clear the environment, you can run

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

@@ -5,7 +5,7 @@ _venv() {
     cur_word="${COMP_WORDS[COMP_CWORD]}"
     prev_word="${COMP_WORDS[COMP_CWORD-1]}"
 
-    _subcommands="activate clear create deactivate install lock sync"
+    _subcommands="activate clear create deactivate install lock"
     subcommands=( $(compgen -W "${_subcommands}" -- "${cur_word}") )
     help_options=( $(compgen -W "-h --help" -- "${cur_word}") )
 
@@ -51,12 +51,6 @@ _venv() {
             COMPREPLY+=( ${help_options[*]} )
             compopt -o plusdirs +o nosort  # Add directories after generated completions
             ;;
-        "sync")
-            # Generate completions for lock file paths
-            COMPREPLY+=( $(compgen -f -X '!*.lock' -- "${cur_word}" | sort) )
-            COMPREPLY+=( ${help_options[*]} )
-            compopt -o plusdirs +o nosort  # Add directories after generated completions
-            ;;
         "activate"|"deactivate"|"clear")
             # Only generate help options
             COMPREPLY+=( ${help_options[*]} )

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

@@ -4,7 +4,7 @@ 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 subcommands=("create" "activate" "install" "lock" "clear" "deactivate" "-V" "--version")
 local -a command_options=("-h" "--help")
 local -a all=("${subcommands[@]} ${command_options[@]}")
 

src/venv-cli/venv.sh

@@ -302,52 +302,6 @@ venv::clear() {
 }
 
 
-venv::sync() {
-  if venv::_check_if_help_requested "$1"; then
-    echo "venv sync [<lock file>]"
-    echo ""
-    echo "DEPRECATED: This command is deprecated and will be removed in version 2.0."
-    echo "Use 'venv install <requirements.lock>' instead."
-    echo ""
-    echo "Remove all installed packages from the environment (venv clear)"
-    echo "and install all packages specified in <lock file>."
-    echo "The <lock file> must be in the form '*requirements.lock'."
-    echo
-    echo "If no <lock file> is specified, defaults to 'requirements.lock'."
-    echo
-    echo "Examples:"
-    echo "$ venv sync dev-requirements.lock"
-    echo "Clears the environment and installs requirements from 'dev-requirements.lock'."
-    echo
-    echo "$ venv sync"
-    echo "Tries to install from 'requirements.lock'."
-    echo "Clears the environment and installs requirements from 'requirements.lock'."
-    return "${_success}"
-  fi
-
-  venv::color_echo "${_yellow}" "DEPRECATED: This command is deprecated and will be removed in version 2.0. Use 'venv install <requirements.lock>' instead."
-
-  local lock_file
-  if [ -z "$1" ]; then
-    # If no argument passed
-    lock_file="requirements.lock"
-
-  # If full lock file passed
-  else
-    if ! venv::_check_lock_requirements_file "$1" "Can only sync using .lock file"; then
-      return "${_fail}"
-    fi
-
-    lock_file="$1"
-    shift
-  fi
-
-  venv::clear
-  venv::install "${lock_file}" "$@"
-  return "$?"  # Return exit status from venv::install command
-}
-
-
 venv::help() {
   echo "Utility to help create and manage python virtual environments."
   echo "Lightweight wrapper around pip and venv."
@@ -361,8 +315,6 @@ venv::help() {
   echo "install        Install requirements from a requirements file in the current environment"
   echo "lock           Lock installed requirements in a '.lock'-file"
   echo "clear          Remove all installed packages in the current environment"
-  echo "sync           Run 'venv clear', then install locked requirements from a"
-  echo "               '.lock'-file in the current environment"
   echo "deactivate     Deactivate the currently activated virtual environment"
   echo "-h, --help     Show this help and exit"
   echo "-v, --version  Show the venv-cli version number and exit"
@@ -388,7 +340,6 @@ venv::main() {
     | install \
     | lock \
     | clear \
-    | sync \
     | deactivate \
     )
       shift

tests/test_venv_help.py

@@ -26,7 +26,6 @@ def test_venv_help(arg: str, tmp_path: Path, capfd: pytest.CaptureFixture):
         "install",
         "lock",
         "clear",
-        "sync",
     ],
 )
 @pytest.mark.parametrize("help_arg", ["-h", "--help"])