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

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

Always create a virtual environment with `venv` or any other preferred solution:

.. code-block:: bash

    python3 -m venv .venv && source .venv/bin/activate && python3 -m pip install --upgrade pip

From PyPI:

.. code-block:: bash

   python3 -m pip install pyvss


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

   python3 -m pip --version

.. note::

   If you don't have `pip` installed, first download and install `Python 3.8 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

   python3 -m 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.8 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\python38\lib\site-packages\pip (python 3.8)

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



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