Installation and Upgrade
========================

Installing the library is quite simple. Either clone the GitLab
repository or download the source code or use pip to do everything for you:

Installation
------------

From PyPI:

.. code-block:: bash

   pip install pyvss

From source via HTTPS or SSH:

.. code-block:: bash

   git clone https://gitlab.eis.utoronto.ca/vss/py-vss
   cd py-vss
   python setup.py install

.. note:: To be able to fetch from gitlab.eis.utoronto.ca via SSH,
  first make sure to add your client account's SSH pub key in
  gitlab's "Settings > SSH Keys".


.. code-block:: bash

   git clone git@gitlab.eis.utoronto.ca:vss/py-vss
   cd py-vss
   python setup.py install

macOS
~~~~~

XCode is required if you are planning to interact with VSKEY-STOR via
`WebdavClient <http://designerror.github.io/webdav-client-python/>`_.

.. code-block:: bash

   xcode-select --install
   curl https://bootstrap.pypa.io/ez_setup.py -o - | python
   python setup.py install --prefix=/opt/setuptools
   sudo easy_install pyvss
   sudo easy_install webdavclient


Linux
~~~~~

Additional libraries are required iif you are planning to interact with VSKEY-STOR via
`WebdavClient <http://designerror.github.io/webdav-client-python/>`_.

.. code-block:: bash

   sudo apt-get install libxml2-dev libxslt-dev python-dev
   sudo apt-get install libcurl4-openssl-dev python-pycurl
   sudo easy_install pyvss
   sudo easy_install webdavclient


Windows
~~~~~~~

Microsoft Visual Studio Express or Microsoft Visual C++ is required if you are planning
to interact with VSKEY-STOR via `WebdavClient <http://designerror.github.io/webdav-client-python/>`_.

.. code-block:: bash

   easy_install.exe pyvss
   easy_install.exe webdavclient


Upgrade
-------

.. code-block:: bash

   pip install --upgrade pyvss

   # or
   easy_install -U pyvss