Follow the instructions in this guide to install the
webis command on your own machine. For further instructions on working with our Gitlab projects, refer to the Git Setup and Usage Instructions.
Preparation: installing dependencies
Linux / Mac
git(at least version 1.7) and
python(at least either version 2.7 or version 3.2) using your usual method for installing system packages. Depending on your operating system / distribution, these may already be installed by default. Open a terminal and run
python --versionto check.
Go to cygwin.com and do/usr/local/share/webis-cmd/webis.py core install wnload and install the appropriate
cygwindistribution for your operating system (either the 32-bit or 64-bit version)
During installation, make sure that the
opensshpackages are selected
For the remainder of this guide, use the cygwin
bashshell to enter all commands; this will likely be called "Cygwin Terminal" or similar in your start menu
Windows installation has not been tested extensively. If you use the
webiscommand on Windows, let us know what problems you encountered and how you fixed them.
For Windows 10 users: inside the Windows Subsystem for Linux environment, the
webiscommand can be installed using the normal Linux instructions below.
Installing and updating the
Multi-user machines (Linux/Mac only)
If you have more than one user account on your machine, and multiple accounts will use the
webis command, you need to install it using the following procedure: (there "probably" is no equivalent way to do this on Windows)
- Clone the
code-webis-cmdgit repository into a system-wide directory:
$ sudo git clone https://git.webis.de/code-generic/code-webis-cmd.git /usr/local/share/webis-cmd
- Run the installation script:
$ sudo /usr/local/share/webis-cmd/webis.py core install
- Now, you should have the
webiscommand on your PATH:
$ webis -h usage: webis [-h] <command> ... positional arguments: <command> Available commands: betaweb (bw) High level scripts for betaweb, e.g. hadoop management. core (co) Core functions of webis command. git Helper scripts for working with the webis Git server and GitLab instance. ...
- To update to the newest version, run the
core/updatecommand as root:
$ sudo webis core update
Alternative Instructions for Old Ubuntu Versions
If your version of Ubuntu doesn't ship at least Python3.6, you will have to use the deadsnakes repository to install a newer Python version first. Instead of all the above, execute the following commands in sequence, as root:
apt-get update apt-get install -y software-properties-common git pep8 python3-pip add-apt-repository -y ppa:deadsnakes/ppa apt-get update apt-get install -y python3.8 python3.8-venv update-alternatives --install /usr/bin/python3 python3 /usr/bin/python3.8 10 python3 -m easy_install -U pip python3 -m pip install -U setuptools wheel git clone https://git.webis.de/code-generic/code-webis-cmd.git /usr/local/share/webis-cmd python3 /usr/local/share/webis-cmd/setup.py install /usr/local/share/webis-cmd/webis.py core install
If you have only one user account, you don't need to clone the repository to a system-wide folder, any location (e.g. in your HOME directory) will do, for example:
$ git clone https://git.webis.de/code-generic/code-webis-cmd.git ~/webis-cmd $ sudo ~/webis-cmd/webis.py core install
In this case, you don't need sudo to update:
$ webis core update
Note 1: if you're on Windows, the
webis.py core install script will probably not work as intended. You can still use the
webis command for most tasks, if you can make sure that the
webis.py driver script is on your system PATH.
Note 2: if you're using Linux and a single user installation, the
webis command might not be found, as some distributions don't include
~/.local/bin in their PATH. To resolve that issue, you can add
PATH="$HOME/.local/bin:$PATH" to your