├── environment.yml ├── src ├── cpip-clean └── cpip-pack ├── README.md ├── bin └── cpip └── LICENSE /environment.yml: -------------------------------------------------------------------------------- 1 | name: cpip 2 | channels: 3 | - defaults 4 | - conda-forge 5 | dependencies: 6 | - conda>=4.6 # <-- reflect this requirement in the README 7 | - conda-pack 8 | - jq==1.6 9 | - python>=3.5,<3.8 10 | 11 | -------------------------------------------------------------------------------- /src/cpip-clean: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | # cpip -- portable packaging for conda + pip environments 4 | # Copyright (C) 2018 Alden Goldstein, Eigen Technologies 5 | # 6 | # This program is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # This program is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with this program. If not, see . 18 | 19 | usage() 20 | { 21 | echo "$help" "usage: $script_name [options]" 22 | echo "$____" 23 | echo "$____" "arguments: (at least one is required)" 24 | echo "$____" " --slip, -s Remove source cache, lockfiles, index cache, and" 25 | echo "$____" " packages for conda." 26 | echo "$____" " --tarballs, -t Remove downloaded tarballs for conda. Best to use" 27 | echo "$____" " only if there is a shortage of disk space." 28 | echo "$____" " --pip-cache, -p Remove cpip's pip cache." 29 | echo "$____" 30 | echo "$____" "options:" 31 | echo "$____" " --yes Consent to deletion without prompts." 32 | echo "$____" " --color Force colored output." 33 | echo "$____" " --no-color Disable colored output." 34 | echo "$____" " --quiet, -q Suppress output for commands." 35 | echo "$____" " --help, -h Show this help message then exit." 36 | } 37 | 38 | arg_count=0 39 | while [[ $# -gt 0 ]]; do 40 | case $1 in 41 | -s|--slip) 42 | slip="$1" 43 | ((++arg_count)) 44 | shift # past argument 45 | ;; 46 | -t|--tarballs) 47 | tarballs="$1" 48 | ((++arg_count)) 49 | shift # past argument 50 | ;; 51 | -p|--pip-cache) 52 | pip_cache="$1" 53 | ((++arg_count)) 54 | shift # past argument 55 | ;; 56 | --yes) 57 | yes="$1" 58 | shift # past argument 59 | ;; 60 | --color) 61 | shift # past argument 62 | ;; 63 | --no-color) 64 | shift # past argument 65 | ;; 66 | -q|--quiet) 67 | quiet="$1" 68 | export PIP_QUIET=1 69 | shift # past argument 70 | ;; 71 | -h|--help) 72 | usage 73 | exit 0 74 | ;; 75 | *) 76 | >&2 echo "$error" "'$1' not a recognized argument/option" 77 | >&2 usage 78 | exit 1 79 | ;; 80 | esac 81 | done 82 | 83 | if [[ $arg_count -eq 0 ]]; then 84 | >&2 echo "$error" "at least one argument is required" 85 | >&2 usage 86 | exit 1 87 | fi 88 | 89 | # exit as soon as a command fails and print error 90 | set -E 91 | trap err_trap ERR SIGHUP SIGINT SIGQUIT SIGTERM 92 | 93 | conda_initiate 94 | remove_old_env 95 | 96 | if [[ $slip ]]; then 97 | echo "$info" "removing source cache, lockfiles, index cache, and packages for conda..." 98 | conda clean -slip $yes $quiet $log_quiet 99 | fi 100 | 101 | if [[ $tarballs ]]; then 102 | echo "$info" "removing downloaded tarballs for conda..." 103 | conda clean --tarballs $yes $quiet $log_quiet 104 | fi 105 | 106 | if [[ $pip_cache ]]; then 107 | set_pip_cache_dir 108 | echo "$info" "clearing pip cache directory '$PIP_CACHE_DIR'..." 109 | rm -rf "$PIP_CACHE_DIR" 110 | fi 111 | 112 | echo "$info" "Done!" 113 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # cpip 2 | 3 | ## What is it? 4 | This tool builds a `conda` environment with `pip` dependencies together 5 | in a way that allows for cross-distro/cross-version compatibility. 6 | 7 | They are two ways to use `cpip`: 8 | 9 | - `cpip pack` will package the environment into a portable tarball. 10 | - `cpip create` will simply create a ready-to-use environment. 11 | 12 | The advantage of having a `create` command gives the user the option 13 | to create the environment in the exact same way as the one that will 14 | be deployed via the `pack` command. 15 | 16 | ## How does it work? 17 | 1. Assembles an environment with basic `conda` commands from 18 | given `conda` environment files 19 | 1. Installs cross-compilers and downloads/compiles `pip` packages 20 | 1. Packages `conda` environment via `conda-pack` tool 21 | 1. Unpacks environment to desired location (only for `create` command) 22 | 23 | ## Supported Operating Systems 24 | - Linux 25 | - macOS 26 | 27 | ## System Requirements 28 | - [conda](https://conda.io/docs/) (version 4.6 or higher) 29 | - [poetry](https://poetry.eustace.io/docs/) (optional) 30 | 31 | ## Environment Dependencies 32 | - [conda-pack](https://conda.github.io/conda-pack/) (installed via `conda`) 33 | - [jq](https://stedolan.github.io/jq/) (installed via `conda`) 34 | - [python](https://www.python.org/) (installed via `conda`) 35 | 36 | ## Usage 37 | 38 | ### 1) Add cpip to your PATH environment variable 39 | 40 | The command below will add `cpip` to your `PATH` environment variable; 41 | make sure to substitute `` for the absolute path 42 | of the `cpip` repository. 43 | 44 | `export PATH=/bin>:$PATH` 45 | 46 | To keep this configuration every time you open a new shell, 47 | make sure to add this command to your shell configuration file. 48 | - for login `bash` shells this will be `~/.bash_profile` 49 | - for non-login `bash` shells this will be `~/.bashrc` 50 | 51 | ### 2) Update Conda 52 | `conda update -n base -c defaults conda` 53 | 54 | ### 3) Update Terminal Environment 55 | `conda init` + restart terminal 56 | 57 | ### 4) Create Build Environment 58 | `conda env create` from base of `cpip` directory 59 | 60 | ### 5) Activate Build Environment 61 | `conda activate cpip` 62 | 63 | ### 6) Run 'cpip pack' or 'cpip create' 64 | For more information: `cpip pack --help` or `cpip create --help` 65 | 66 | ### 7) Unpack and Activate 67 | Initial Setup (if using 'cpip pack'): 68 | 1. untar archive --> tar -xf 69 | 2. activate environment --> source /bin/activate 70 | 3. fix path prefixes --> conda-unpack 71 | 72 | Normal Use: 73 | * activate --> source /bin/activate 74 | * deactivate --> source deactivate 75 | 76 | **NOTE:** It's possible to change the path of `` after 77 | untarring, as long that is done prior to running `conda-unpack`. 78 | 79 | ## Cleaning Caches 80 | Use `cpip clean` command to clean the `conda` and/or `pip` caches 81 | 82 | ## Other Things to Note 83 | 84 | ### Installing pip dependencies with Conda vs. Poetry 85 | `pip` dependencies can be installed via `conda` or `poetry`. 86 | It is recommended to use a `poetry` project to define all the `pip` 87 | packages in your project; this allows for lockfiles to pin package 88 | versions properly. If you decide to use `poetry`, it makes sense to 89 | move ALL `pip` dependencies from the `conda` environment file(s) to 90 | a `poetry` project file. 91 | 92 | ### Cross-Compilers 93 | Cross-compilers will be installed if any `pip` dependencies are 94 | detected, or the `--command` option is used. They will always be 95 | uninstalled automatically before the environment is finalized. 96 | 97 | The cross-compilers used are Anaconda compiler tools 98 | (see [here](https://conda.io/docs/user-guide/tasks/build-packages/compiler-tools.html)). 99 | They are not true cross-compilers since they are not configured to work cross-platform. 100 | However, they are configured to give a high degree of compatibility from one 101 | distro/version to another. 102 | 103 | **NOTE:** If any Anaconda compiler tools or associated runtime libraries are 104 | present in the environment file(s), they will be removed completely. Only the 105 | compiler runtime libraries will be reinstalled, and potentially of different 106 | versions than before. 107 | 108 | ### Running Commands in the Newly Created Environment 109 | Immediately after the environment is created, it may be desired to run 110 | certain commands in the active environment. To do this, we can use the 111 | `--command` option as many times as desired to pass in commands that we 112 | want to run while the environment is active. `cpip` will ensure that 113 | cross-compilers are installed in the environment, so that the build 114 | environment for running commands is consistent with the build environment 115 | for compiling `pip` packages. 116 | 117 | ### Order of Environments 118 | This tool can take more than one `conda` environment file. 119 | These files will be loaded in the order they are given on 120 | the command line. Different command line orders may produce 121 | slightly different environments. 122 | 123 | ### Conda Configuration 124 | Changing certain configuration values may yield unexpected results. 125 | 126 | ### Poetry Configuration 127 | `cpip pack` internally sets `settings.virtualenvs.create` to `false`, 128 | but restores the setting to its original value upon failure or completion. 129 | 130 | ### Concurrency 131 | Running more than one `cpip` command simultaneously is not supported. 132 | 133 | ### TODO: Non-Unix Systems 134 | For systems that don't respect the `XDG_CACHE_HOME` environment variable, 135 | Poetry may have concurrency issues, however, if using a `poetry.lock` file, 136 | this will relieve any potential cache conflicts. 137 | 138 | The cache issues can be solved completely if `poetry` allows for the 139 | something more flexible like a `--poetry-cache-dir` command line option. 140 | -------------------------------------------------------------------------------- /bin/cpip: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | # cpip -- portable packaging for conda + pip environments 4 | # Copyright (C) 2018 Alden Goldstein, Eigen Technologies 5 | # 6 | # This program is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # This program is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with this program. If not, see . 18 | 19 | # store script name and empty string equivalent 20 | script_name="$(basename -- "$0")" 21 | script_dir="$(dirname -- "$0")" 22 | src_dir="$script_dir/../src" 23 | set_space() 24 | { 25 | space="$(len=${#1}; ch=' '; printf '%*s' "$len" | tr ' ' "$ch")" 26 | } 27 | set_script_space() 28 | { 29 | set_space "$script_name" 30 | ___________="$space" 31 | } 32 | set_script_space 33 | 34 | set_colors() 35 | { 36 | bold=`tput bold` 37 | red=`tput setaf 1` 38 | green=`tput setaf 2` 39 | yellow=`tput setaf 3` 40 | blue=`tput setaf 4` 41 | magenta=`tput setaf 5` 42 | cyan=`tput setaf 6` 43 | reset=`tput sgr0` 44 | } 45 | 46 | min_args=0 47 | for arg in $@; do 48 | if [[ $arg == "--no-color" ]]; then 49 | no_color=true 50 | ((++min_args)) 51 | fi 52 | if [[ $arg == "--color" ]]; then 53 | color=true 54 | ((++min_args)) 55 | fi 56 | done 57 | 58 | if [[ ! -t 1 ]]; then 59 | # set quiet logging for everything but Poetry 60 | log_quiet="--quiet" 61 | export PIP_PROGRESS_BAR="off" 62 | 63 | # turn off colored output by default 64 | no_color=true 65 | if [[ $color ]]; then 66 | unset no_color 67 | fi 68 | fi 69 | 70 | if [[ $no_color ]]; then 71 | export PIP_NO_COLOR=1 72 | no_ansi="--no-ansi" 73 | else 74 | ansi="--ansi" 75 | set_colors 76 | fi 77 | 78 | # set print commands 79 | default_tag="${bold}${magenta}[${cyan}$script_name${magenta}]${reset}" 80 | 81 | # store empty string equivalent of 'info' and 'help' 82 | four_space="[$script_name] FOUR:" 83 | set_space "$four_space" 84 | ____="$space" 85 | 86 | set_logging() 87 | { 88 | local tag="$1" 89 | info="$tag ${green}INFO:${reset}" 90 | warning="$tag ${yellow}WARNING:${reset}" 91 | error="$tag ${red}ERROR:${reset}" 92 | help="$tag ${blue}HELP:${reset}" 93 | } 94 | 95 | set_logging "$default_tag" 96 | 97 | # check os to find the right compilers 98 | if [[ $OSTYPE == "linux-gnu" ]]; then 99 | cc_pkg="gcc_linux-64==7.2.0" 100 | cxx_pkg="gxx_linux-64==7.2.0" 101 | gfortran_pkg="gfortran_linux-64==7.2.0" 102 | ld_impl="ld_impl_linux-64==2.33.1" 103 | swig_pkg="swig==4.0.2" 104 | pkg_config="pkg-config==0.29.2" 105 | linux=true 106 | elif [[ $OSTYPE == "darwin"* ]]; then 107 | cc_pkg="clang_osx-64" 108 | cxx_pkg="clangxx_osx-64" 109 | gfortran_pkg="gfortran_osx-64" 110 | swig_pkg="swig" 111 | pkg_config="pkg-config" 112 | macos=true 113 | else 114 | >&2 echo "$error" "OS not supported!" 115 | exit 1 116 | fi 117 | 118 | env="cpip_env" 119 | 120 | conda_initiate() 121 | { 122 | if [[ $CONDA_DEFAULT_ENV != "cpip" ]]; then 123 | >&2 echo "$error" "cpip environment must be active! please run 'conda activate cpip' prior to use" 124 | exit 1 125 | fi 126 | export CONDA_SHLVL=0 127 | source "$CONDA_PREFIX/etc/profile.d/conda.sh" 128 | conda activate 129 | } 130 | 131 | conda_env_create() 132 | { 133 | echo "$info" "creating environment..." 134 | conda create -n "$env" --yes $quiet $log_quiet 135 | } 136 | 137 | conda_env_update() 138 | { 139 | echo "$info" "updating environment with '$file' file..." 140 | conda-env update -n "$env" -f "$file" $quiet $log_quiet 141 | } 142 | 143 | conda_env_remove() 144 | { 145 | echo "$info" "removing environment..." 146 | conda-env remove -n "$env" --yes $quiet $log_quiet 147 | } 148 | 149 | remove_old_env() 150 | { 151 | local env_path="$CONDA_PREFIX/envs/$env" 152 | if [[ $(conda-env list --json | jq -r '.envs | .[]' | grep -x "$env_path" | wc -l) -gt 0 ]]; then 153 | conda_env_remove 154 | fi 155 | 156 | # remove environment manually in case conda couldn't find it 157 | rm -rf "$env_path" 158 | } 159 | 160 | set_pip_cache_dir() 161 | { 162 | export PIP_CACHE_DIR="$CONDA_PREFIX/pip/cache" 163 | } 164 | 165 | py_realpath() 166 | { 167 | python -c "import os; print(os.path.realpath(\"$1\"))" 168 | } 169 | 170 | err_trap() 171 | { 172 | local lc="$BASH_COMMAND" rc=$? 173 | if [[ $rc -ne 0 ]]; then 174 | >&2 echo "$error" "Command [${red}$lc${reset}] failed with exit code [${red}$rc${reset}]" 175 | fi 176 | exit $rc 177 | } 178 | 179 | usage() 180 | { 181 | echo "$help" "usage: $script_name [options]" 182 | echo "$____" 183 | echo "$____" "Portable packaging for conda + pip environments" 184 | echo "$____" 185 | echo "$____" "commands:" 186 | echo "$____" " pack Package environment into a tarball." 187 | echo "$____" " create Create conda environment." 188 | echo "$____" " clean Cleanup conda and/or pip cache." 189 | echo "$____" 190 | echo "$____" "options:" 191 | echo "$____" " --color Force colored output." 192 | echo "$____" " --no-color Disable colored output." 193 | echo "$____" " --help, -h Show this help message then exit." 194 | } 195 | 196 | if [[ $# -le $min_args ]]; then 197 | usage 198 | exit 0 199 | fi 200 | 201 | while [[ $# -gt 0 ]]; do 202 | case $1 in 203 | pack) 204 | script_name+=" $1" 205 | set_script_space 206 | shift # past argument 207 | source "$src_dir/cpip-pack" 208 | ;; 209 | create) 210 | script_name+=" $1" 211 | set_script_space 212 | shift # past argument 213 | create=true 214 | source "$src_dir/cpip-pack" 215 | ;; 216 | clean) 217 | script_name+=" $1" 218 | set_script_space 219 | shift # past argument 220 | source "$src_dir/cpip-clean" 221 | ;; 222 | --color) 223 | shift # past argument 224 | ;; 225 | --no-color) 226 | shift # past argument 227 | ;; 228 | -h|--help) 229 | usage 230 | exit 0 231 | ;; 232 | *) 233 | >&2 echo "$error" "'$1' not a recognized command" 234 | >&2 usage 235 | exit 1 236 | ;; 237 | esac 238 | done 239 | -------------------------------------------------------------------------------- /src/cpip-pack: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | # cpip -- portable packaging for conda + pip environments 4 | # Copyright (C) 2018 Alden Goldstein, Eigen Technologies 5 | # 6 | # This program is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # This program is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with this program. If not, see . 18 | 19 | create_and_activate() 20 | { 21 | # create and ENTER target environment 22 | conda_env_create 23 | conda activate "$env" 24 | } 25 | 26 | set_compiler_env() 27 | { 28 | # refresh current environment 29 | local current_env="$CONDA_DEFAULT_ENV" 30 | conda deactivate 31 | conda activate "$current_env" 32 | 33 | # NOTE: the compiler options here are pulled straight from the Python Makefile 34 | if [[ $linux ]]; then 35 | export LDSHARED="$CC -shared" 36 | elif [[ $macos ]]; then 37 | export LDSHARED="$CC -bundle -undefined dynamic_lookup" 38 | fi 39 | } 40 | 41 | unset_compiler_env() 42 | { 43 | # refresh current environment 44 | local current_env="$CONDA_DEFAULT_ENV" 45 | conda deactivate 46 | conda activate "$current_env" 47 | 48 | unset LDSHARED 49 | } 50 | 51 | jq_diff() 52 | { 53 | local add="$1" sub="$2" 54 | echo "{\"add\": $add, \"sub\": $sub}" | jq '.add-.sub' 55 | } 56 | 57 | install_compilers() 58 | { 59 | if [[ -z $compilers_installed ]]; then 60 | if [[ $compiler_pkgs ]]; then 61 | # find interfering packages and remove them 62 | local current_pkgs="$(conda list --json | jq '[.[].name]')" 63 | local missing_pkgs="$(jq_diff "$compiler_pkgs" "$current_pkgs")" 64 | local interfering_pkgs="$(jq_diff "$compiler_pkgs" "$missing_pkgs" | jq -r '.[]')" 65 | if [[ $interfering_pkgs ]]; then 66 | echo "$warning" "found interfering compiler packages in the environment, uninstalling..." 67 | conda uninstall ${interfering_pkgs[@]} --force --yes $quiet $log_quiet 68 | fi 69 | 70 | echo "$info" "installing compilers..." 71 | else 72 | echo "$info" "establishing compiler packages..." 73 | fi 74 | 75 | # install compilers 76 | local pkgs=("$cc_pkg" "$cxx_pkg" "$gfortran_pkg" "$swig_pkg" "$ld_impl" "$pkg_config") 77 | local pkg_diff="$(conda install --override-channels -c anaconda ${pkgs[@]} --no-update-deps --json --quiet)" 78 | local install_error="$(echo "$pkg_diff" | jq -r '.error')" 79 | if [[ $install_error != "null" ]]; then 80 | >&2 echo -e "$error" "$install_error" 81 | exit 1 82 | fi 83 | 84 | # find added and deleted packages 85 | local actions="$(echo "$pkg_diff" | jq '.actions')" 86 | [[ $actions != "null" ]] && 87 | local link="$(echo "$actions" | jq '.LINK')" 88 | [[ $actions != "null" ]] && 89 | local unlink="$(echo "$actions" | jq '.UNLINK')" 90 | [[ $link ]] && [[ $link != "null" ]] && 91 | local add="$(echo "$link" | jq '[.[].name]')" 92 | [[ $unlink ]] && [[ $unlink != "null" ]] && 93 | local sub="$(echo "$unlink" | jq '[.[].name]')" 94 | 95 | # filter out only packages that were added, NOT updated/downgraded 96 | all_compiler_pkgs="$add" 97 | [[ $add ]] && 98 | tmp_pkgs="$add" 99 | [[ $add ]] && [[ $sub ]] && 100 | tmp_pkgs="$(jq_diff "$add" "$sub")" 101 | 102 | # library packages and pcre stay, the rest are temporary 103 | [[ $tmp_pkgs ]] && 104 | tmp_pkgs="$(echo "$tmp_pkgs" | jq -r '.[]' | grep -v "^_\|^lib\|^pcre")" 105 | [[ $build_tools ]] && unset tmp_pkgs 106 | 107 | set_compiler_env 108 | compilers_installed=true 109 | fi 110 | } 111 | 112 | set_compiler_pkgs() 113 | { 114 | compiler_pkgs="$all_compiler_pkgs" 115 | } 116 | 117 | uninstall_compilers() 118 | { 119 | if [[ $compilers_installed ]] && [[ $tmp_pkgs ]]; then 120 | echo "$info" "uninstalling compilers..." 121 | conda uninstall ${tmp_pkgs[@]} --force --yes $quiet $log_quiet 122 | unset compilers_installed 123 | unset_compiler_env 124 | fi 125 | } 126 | 127 | conditional_install_compilers() 128 | { 129 | if [[ $build_tools ]] || [[ $pip_install ]] || [[ $poetry_dir ]] || [[ ${#commands[@]} -gt 0 ]]; then 130 | install_compilers 131 | fi 132 | } 133 | 134 | pip_quiet_save() 135 | { 136 | [[ $PIP_QUIET ]] && pip_quiet="$PIP_QUIET" 137 | export PIP_QUIET=1 138 | } 139 | 140 | pip_quiet_restore() 141 | { 142 | if [[ $pip_quiet ]]; then 143 | export PIP_QUIET="$pip_quiet" 144 | unset "$pip_quiet" 145 | fi 146 | } 147 | 148 | set_pip_local_install() 149 | { 150 | mkdir -p "$PIP_CACHE_DIR/wheels" # <-- suppress warning for missing directory 151 | export PIP_ONLY_BINARY=":all:" 152 | export PIP_FIND_LINKS="$(find "$PIP_CACHE_DIR/wheels" -name *.whl)" 153 | 154 | # turn off pip verbosity since the messages will be redundant 155 | pip_quiet_save 156 | unset PIP_QUIET 157 | } 158 | 159 | unset_pip_local_install() 160 | { 161 | unset PIP_ONLY_BINARY 162 | unset PIP_FIND_LINKS 163 | pip_quiet_restore 164 | } 165 | 166 | install_pip() 167 | { 168 | if [[ $(conda list --json | jq -r '.[].name' | grep "^pip$" | wc -l) -eq 0 ]]; then 169 | echo "$info" "pip is missing from conda environment, installing..." 170 | conda install --override-channels -c anaconda pip --no-update-deps --yes $quiet $log_quiet 171 | fi 172 | } 173 | 174 | get_poetry_major_version() 175 | { 176 | poetry_major_version="$(poetry --version | awk '{print $3}' | cut -f1 -d '.')" 177 | poetry_major_version="${poetry_major_version:-0}" 178 | } 179 | 180 | set_poetry_config() 181 | { 182 | if [[ $poetry_major_version -eq 0 ]]; then 183 | venvs_create="$(poetry config settings.virtualenvs.create)" # <-- save previous value 184 | poetry config settings.virtualenvs.create "false" 185 | else 186 | venvs_create="$(poetry config virtualenvs.create)" # <-- save previous value 187 | poetry config virtualenvs.create "false" 188 | fi 189 | } 190 | 191 | restore_poetry_config() 192 | { 193 | if [[ $venvs_create ]]; then 194 | if [[ $poetry_major_version -eq 0 ]]; then 195 | poetry config settings.virtualenvs.create "$venvs_create" 196 | else 197 | poetry config virtualenvs.create "$venvs_create" 198 | fi 199 | unset venvs_create 200 | fi 201 | } 202 | 203 | make_temp() 204 | { 205 | temp_dir=$(mktemp -d) 206 | temp_file="$temp_dir/$env.tar.gz" 207 | temp_created=true 208 | } 209 | 210 | remove_temp() 211 | { 212 | if [[ $temp_created ]]; then 213 | rm -rf "$temp_dir" 214 | unset temp_created 215 | fi 216 | } 217 | 218 | run_post_conda_commands() 219 | { 220 | index=1 221 | for cmd in "${post_conda_commands[@]}"; do 222 | command_tag="${bold}[${blue}command ($index of ${#post_conda_commands[@]})${reset}${bold}]${reset}" 223 | set_logging "$default_tag $command_tag" 224 | echo "$info" "running '$cmd'..." 225 | (eval "$cmd") 226 | ((++index)) 227 | done 228 | set_logging "$default_tag" 229 | } 230 | 231 | run_commands() 232 | { 233 | index=1 234 | for cmd in "${commands[@]}"; do 235 | command_tag="${bold}[${blue}command ($index of ${#commands[@]})${reset}${bold}]${reset}" 236 | set_logging "$default_tag $command_tag" 237 | echo "$info" "running '$cmd'..." 238 | (eval "$cmd") 239 | ((++index)) 240 | done 241 | set_logging "$default_tag" 242 | } 243 | 244 | exit_trap() 245 | { 246 | restore_poetry_config 247 | remove_temp 248 | } 249 | 250 | complete_msg() 251 | { 252 | if [[ $create ]]; then 253 | echo "$info" "Complete! Environment is now installed in '$output'" 254 | echo "$help" "[Instructions]" 255 | echo "$____" 256 | echo "$____" " Normal Use:" 257 | echo "$____" " * activate --> source \"$output/bin/activate\"" 258 | echo "$____" " * deactivate --> source deactivate" 259 | echo "$____" 260 | echo "$____" " If in 'envs' folder:" 261 | echo "$____" " * activate --> conda activate \"$name\"" 262 | echo "$____" " * deactivate --> conda deactivate" 263 | else 264 | echo "$info" "Complete! Environment is now packaged at '$output'" 265 | echo "$help" "[Instructions]" 266 | echo "$____" 267 | echo "$____" " Initial Setup:" 268 | echo "$____" " 1. untar archive --> tar -xf \"$output_file\"" 269 | echo "$____" " 2. activate environment --> source \"$name/bin/activate\"" 270 | echo "$____" " 3. fix path prefixes --> conda-unpack" 271 | echo "$____" 272 | echo "$____" " Normal Use:" 273 | echo "$____" " * activate --> source \"$name/bin/activate\"" 274 | echo "$____" " * deactivate --> source deactivate" 275 | fi 276 | } 277 | 278 | usage() 279 | { 280 | echo "$help" "usage: $script_name --name PROJECT [--file FILE]..." 281 | echo "$____" " $___________ [--poetry DIR] [--output DIR]" 282 | echo "$____" " $___________ [--post-conda-command COMMAND]..." 283 | echo "$____" " $___________ [--command COMMAND]..." 284 | if [[ -z $create ]]; then 285 | echo "$____" " $___________ [--version VERSION]" 286 | fi 287 | echo "$____" " $___________ [--extra PACKAGE]..." 288 | echo "$____" " $___________ [--no-dev] [--unlock]" 289 | echo "$____" " $___________ [--build-tools]" 290 | echo "$____" " $___________ [--force]" 291 | echo "$____" " $___________ [--color] [--no-color] [--quiet]" 292 | echo "$____" " $___________ [--help]" 293 | } 294 | 295 | advanced_usage() 296 | { 297 | 298 | # NOTE: if you update this print message, please update README.md 299 | usage 300 | echo "$____" 301 | if [[ $create ]]; then 302 | local output="folder" 303 | echo "$____" "Create a conda environment from the given dependencies" 304 | else 305 | local output="tarball" 306 | echo "$____" "Package all dependencies into a portable conda environment tarball" 307 | fi 308 | echo "$____" 309 | 310 | echo "$____" "required arguments:" 311 | echo "$____" " --name, -n PROJECT Name of the project. Will be used for the name in" 312 | echo "$____" " the output $output." 313 | echo "$____" 314 | echo "$____" "optional arguments:" 315 | echo "$____" " --file, -f FILE Conda environment file. This option can be used" 316 | echo "$____" " multiple times to specify multiple files. The" 317 | echo "$____" " environment will be updated in the order that they" 318 | echo "$____" " are given on the command line." 319 | echo "$____" " --poetry, -p DIR Poetry project directory." 320 | echo "$____" " --output, -o DIR Directory where the final $output will go." 321 | echo "$____" " Otherwise, $output will be ouputed to the current" 322 | echo "$____" " working directory." 323 | echo "$____" " --post-conda-command COMMAND Command to run after the conda environment is setup." 324 | echo "$____" " This option can be used multiple times to specify" 325 | echo "$____" " multiple commands to run. They will be ran in the" 326 | echo "$____" " order that they are given on the command line." 327 | echo "$____" " --command, -c COMMAND Command to run after the environment is setup." 328 | echo "$____" " This option can be used multiple times to specify" 329 | echo "$____" " multiple commands to run. They will be ran in the" 330 | echo "$____" " order that they are given on the command line." 331 | if [[ -z $create ]]; then 332 | echo "$____" " --version, -v VERSION Version number to be included in output $output." 333 | fi 334 | echo "$____" " --extra, -e PACKAGE Extra dependency package to install for Poetry." 335 | echo "$____" " This option can be used multiple times to specify" 336 | echo "$____" " multiple packages." 337 | echo "$____" " --no-dev Do not install dev dependencies for Poetry." 338 | echo "$____" " --ignore-editable-packages Ignore any editable packages installed in the" 339 | echo "$____" " environment when packing." 340 | echo "$____" " --unlock Update Poetry dependencies and overwrite lockfile." 341 | echo "$____" " --build-tools Install build tools into the final environment." 342 | echo "$____" " --force Overwrite any existing $output at the output path." 343 | echo "$____" " --color Force colored output." 344 | echo "$____" " --no-color Disable colored output." 345 | echo "$____" " --quiet, -q Suppress output for subprocesses." 346 | echo "$____" " --help, -h Show this help message then exit." 347 | } 348 | 349 | opt_twice_err() 350 | { 351 | >&2 echo "$error" "'$1' option cannot be used more than once" 352 | >&2 usage 353 | exit 1 354 | } 355 | 356 | opt_invalid_err() 357 | { 358 | >&2 echo "$error" "'$1' not a recognized option" 359 | >&2 usage 360 | exit 1 361 | } 362 | 363 | missing_val_err() 364 | { 365 | >&2 echo "$error" "'$1' option requires a value" 366 | >&2 usage 367 | exit 1 368 | } 369 | 370 | post_conda_commands=() 371 | commands=() 372 | extras=() 373 | files=() 374 | while [[ $# -gt 0 ]]; do 375 | case $1 in 376 | -n|--name) 377 | [[ $name ]] && opt_twice_err "--name" 378 | [[ -z $2 ]] && missing_val_err "--name" 379 | name="$2" 380 | shift # past argument 381 | shift # past value 382 | ;; 383 | -f|--file) 384 | [[ -z $2 ]] && missing_val_err "--file" 385 | files+=("$2") 386 | shift # past argument 387 | shift # past value 388 | ;; 389 | -p|--poetry) 390 | [[ $poetry_dir ]] && opt_twice_err "--poetry" 391 | [[ -z $2 ]] && missing_val_err "--poetry" 392 | poetry_dir="$2" 393 | shift # past argument 394 | shift # past value 395 | ;; 396 | -o|--output) 397 | [[ $output_dir ]] && opt_twice_err "--output" 398 | [[ -z $2 ]] && missing_val_err "--output" 399 | output_dir="$2" 400 | shift # past argument 401 | shift # past value 402 | ;; 403 | --post-conda-command) 404 | [[ -z $2 ]] && missing_val_err "--post-conda-command" 405 | post_conda_commands+=("$2") 406 | shift # past argument 407 | shift # past value 408 | ;; 409 | -c|--command) 410 | [[ -z $2 ]] && missing_val_err "--command" 411 | commands+=("$2") 412 | shift # past argument 413 | shift # past value 414 | ;; 415 | -v|--version) 416 | [[ $create ]] && opt_invalid_err "$1" 417 | [[ $version ]] && opt_twice_err "--version" 418 | [[ -z $2 ]] && missing_val_err "--version" 419 | version="$2" 420 | shift # past argument 421 | shift # past value 422 | ;; 423 | -e|--extra) 424 | [[ -z $2 ]] && missing_val_err "--extra" 425 | extras+=("$2") 426 | shift # past argument 427 | shift # past value 428 | ;; 429 | --no-dev) 430 | no_dev="$1" 431 | shift # past argument 432 | ;; 433 | --ignore-editable-packages) 434 | ignore_editable="$1" 435 | shift # past argument 436 | ;; 437 | --unlock) 438 | unlock=true 439 | shift # past argument 440 | ;; 441 | --build-tools) 442 | build_tools=true 443 | shift # past argument 444 | ;; 445 | --force) 446 | force="$1" 447 | shift # past argument 448 | ;; 449 | --color) 450 | shift # past argument 451 | ;; 452 | --no-color) 453 | shift # past argument 454 | ;; 455 | -q|--quiet) 456 | quiet="$1" 457 | export PIP_QUIET=1 458 | shift # past argument 459 | ;; 460 | -h|--help) 461 | advanced_usage 462 | exit 0 463 | ;; 464 | *) 465 | opt_invalid_err "$1" 466 | ;; 467 | esac 468 | done 469 | 470 | # check for required options 471 | if [[ -z $name ]]; then 472 | >&2 echo "$error" "'--name' option is required" 473 | >&2 usage 474 | exit 1 475 | fi 476 | 477 | # make sure environment files exist 478 | for file in "${files[@]}"; do 479 | if [[ ! -f $file ]]; then 480 | >&2 echo "$error" "'$file' is either not a file or it doesn't exist" 481 | >&2 usage 482 | exit 1 483 | fi 484 | done 485 | 486 | # set full output path 487 | if [[ -z $output_dir ]]; then 488 | output_dir="$(pwd)" 489 | fi 490 | if [[ ! -d $output_dir ]]; then 491 | >&2 echo "$error" "'$output_dir' is not a directory or does not exist" 492 | exit 1 493 | fi 494 | 495 | # set other output variables 496 | output_dir="$(py_realpath "$output_dir")" # <-- set to absolute path 497 | if [[ $create ]]; then 498 | output="$output_dir/$name" 499 | else 500 | output_name="$name" 501 | if [[ $version ]]; then 502 | if [[ ! $version =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then 503 | >&2 echo "$warning" "'$version' does not match numerical format X.Y.Z" 504 | fi 505 | output_name+="-$version" 506 | fi 507 | output_file="$output_name.tar.gz" 508 | output="$output_dir/$output_file" 509 | fi 510 | 511 | if [[ -z $force ]]; then 512 | if [[ $create ]]; then 513 | if [[ -f $output ]] || [[ -d $output ]]; then 514 | >&2 echo "$error" "output folder '$output' already exists; use --force option to overwrite" 515 | exit 1 516 | fi 517 | else 518 | if [[ -f $output ]] || [[ -d $output ]]; then 519 | >&2 echo "$error" "output file '$output' already exists; use --force option to overwrite" 520 | exit 1 521 | fi 522 | fi 523 | fi 524 | 525 | # exit as soon as a command fails and print error 526 | set -E 527 | trap err_trap ERR SIGHUP SIGINT SIGQUIT SIGTERM 528 | trap exit_trap EXIT 529 | 530 | conda_initiate 531 | 532 | # set pip cache directory 533 | set_pip_cache_dir 534 | echo "$info" "using pip cache directory '$PIP_CACHE_DIR'" 535 | 536 | pip_files=() 537 | 538 | # scan for pip dependencies 539 | for file in "${files[@]}"; do 540 | # warn user for pip dependencies 541 | if [[ $(cat "$file" | egrep "^\s*-\s+pip:\s*$" | wc -l) -gt 0 ]]; then 542 | >&2 echo "$warning" "found pip dependencies in '$file'; this is not recommended!" 543 | pip_files+=("$file") 544 | fi 545 | done 546 | 547 | # remove old target environment, recreate and ENTER 548 | remove_old_env 549 | create_and_activate 550 | 551 | # set the full array of compiler packages 552 | install_compilers 553 | set_compiler_pkgs 554 | 555 | if [[ ${#pip_files[@]} -gt 0 ]]; then 556 | pip_install="${bold}[${yellow}pip-install${reset}${bold}]${reset}" 557 | echo "$info" "pip dependencies were found in ${#pip_files[@]} file(s): running $pip_install..." 558 | 559 | # change logging for pip_install 560 | set_logging "$default_tag $pip_install" 561 | 562 | # update the environment 563 | for file in "${pip_files[@]}"; do 564 | conda_env_update 565 | done 566 | 567 | echo "$info" "Complete!" 568 | 569 | # revert logging back to default settings 570 | set_logging "$default_tag" 571 | fi 572 | 573 | # EXIT target environment 574 | conda deactivate 575 | 576 | remove_old_env 577 | set_pip_local_install 578 | unset compilers_installed 579 | 580 | # create and ENTER target environment 581 | create_and_activate 582 | 583 | # install compilers before updating environment <-- very important to follow this order 584 | conditional_install_compilers 585 | 586 | # update the environment 587 | for file in "${files[@]}"; do 588 | conda_env_update 589 | done 590 | 591 | run_post_conda_commands 592 | 593 | # install pip for Poetry 594 | [[ $poetry_dir ]] && install_pip 595 | 596 | # install pip packages in target environment 597 | if [[ $poetry_dir ]]; then 598 | poetry_install="${bold}[${green}poetry-install${reset}${bold}]${reset}" 599 | echo "$info" "Poetry project specified in '$poetry_dir': running $poetry_install..." 600 | 601 | # get the poetry major version 602 | get_poetry_major_version 603 | 604 | # change logging for poetry_install 605 | set_logging "$default_tag $poetry_install" 606 | 607 | poetry_dir="$(py_realpath "$poetry_dir")" # <-- set to absolute path 608 | unset_pip_local_install 609 | set_poetry_config 610 | 611 | # TODO: remove this when Poetry is more capable (see README) 612 | # set Poetry environment to yield independent cache 613 | export XDG_CACHE_HOME="$CONDA_PREFIX/xdg_cache" 614 | 615 | # install pip packages 616 | echo "$info" "installing pip packages via Poetry..." 617 | cd "$poetry_dir" 618 | [[ $unlock ]] && poetry update --lock $no_dev $quiet $ansi $no_ansi 619 | if [[ ${#extras[@]} -gt 0 ]]; then 620 | poetry install $no_dev $quiet $ansi $no_ansi --extras "$(echo ${extras[@]})" 621 | else 622 | poetry install $no_dev $quiet $ansi $no_ansi 623 | fi 624 | cd - 625 | 626 | restore_poetry_config 627 | 628 | # TODO: remove this when Poetry is more capable (see README) 629 | # remove cache and revert environment 630 | rm -rf "$XDG_CACHE_HOME" 631 | unset XDG_CACHE_HOME 632 | 633 | echo "$info" "Complete!" 634 | 635 | # revert logging back to default settings 636 | set_logging "$default_tag" 637 | fi 638 | 639 | run_commands 640 | uninstall_compilers 641 | 642 | # run conda-pack to package the environment (or create) 643 | if [[ $create ]]; then 644 | echo "$info" "packaging environment via conda-pack..." 645 | make_temp 646 | conda-pack -o "$temp_file" -d "$output" --arcroot "$name" --compress-level 0 $force $quiet $log_quiet $ignore_editable 647 | cd "$output_dir" 648 | echo "$info" "unpacking environment..." 649 | [[ $force ]] && rm -rf "$output" 650 | tar -xf "$temp_file" 651 | remove_temp 652 | cd - 653 | else 654 | echo "$info" "packaging environment via conda-pack..." 655 | conda-pack -o "$output" --arcroot "$name" $force $quiet $log_quiet $ignore_editable 656 | fi 657 | 658 | complete_msg 659 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------