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-ee.eis.utoronto.ca/vss/py-vss
   cd py-vss
   python setup.py install

.. note:: To be able to fetch from gitlab-ee.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-ee.eis.utoronto.ca:vss/py-vss
   cd py-vss
   python setup.py install

.. note:: Python 2.7 users must install ``enum34``: ``pip install enum34``.


macOS
~~~~~

You can use `pip` directly to install PyVSS. Run `pip --version` to see if your version of
macOS already includes Python and `pip`.

.. code-block:: bash

   pip --version

.. note::

   If you don't have `pip` installed, first download and install `Python 3.7 for Mac`_ from the
   downloads page of Python.org. Download and run the `pip` installation script provided by the
   Python Packaging Authority.

    .. code-block:: bash

       curl -O https://bootstrap.pypa.io/get-pip.py
       python3 get-pip.py --user

1. Use `pip` to install PyVSS.

.. code-block:: bash

   pip install pyvss --upgrade --user

2. Verify that the PyVSS is installed correctly.

.. code-block:: bash

    pip freeze | grep pyvss

Linux
~~~~~

You can use `pip` directly to install PyVSS. Run `pip --version` to see if your version of
Linux already includes Python and `pip`.

.. code-block:: bash

   pip --version

.. note::

   If you don't have `pip` installed, first download and install `Python 3.7 for Linux`_ from the
   downloads page of Python.org or using your preferred package manager.
   Download and run the `pip` installation script provided by the Python Packaging Authority.

    .. code-block:: bash

       curl -O https://bootstrap.pypa.io/get-pip.py
       python3 get-pip.py --user

1. Use `pip` to install PyVSS.

.. code-block:: bash

   pip install pyvss --upgrade --user

2. Verify that the PyVSS is installed correctly.

.. code-block:: bash

    pip freeze | grep pyvss

Windows
~~~~~~~

1. Open the Command Prompt from the Start menu.

2. Use the following commands to verify that **Python** and `pip` are both installed correctly.

.. code-block:: batch

    C:\Windows\System32> python --version
    Python 3.7.1
    C:\Windows\System32> pip --version
    pip 18.1 from c:\program files\python37\lib\site-packages\pip (python 3.7)

3. Install PyVSS CLI using pip.

.. code-block:: batch

    C:\Windows\System32> pip install pyvss

4. Verify that PyVSS is installed correctly.

.. code-block:: batch

    C:\Windows\System32> pip freeze | findstr pyvss


Upgrade
-------

.. code-block:: bash

   pip install pyvss --upgrade --user
   # or
   easy_install -U pyvss



.. _`Python 3.7 for Mac`: https://www.python.org/downloads/mac-osx/
.. _`Python 3.7 for Linux`: https://www.python.org/downloads/source/