Installing Pyngres
******************

.. IMPORTANT::

    Actian **Ingres**, **Vector**, **OpenROAD**,
    or the Actian **Client Runtime** must be installed before you can use 
    Pyngres. 
    These products are available from the
    `Actian Electronic Software Distribution <https://esd.actian.com/>`_ site.
    
    Pyngres requires Python 3.8 or higher.
    It does not require any specific version of the Actian products.

    Ingres, Vector, and OpenROAD require a licence file. 
    The Client Runtime does not. 

..  TIP::
    Licences can be purchased from Actian Partners
    such as Rational Commerce Ltd. 
    (contact sales@rationalcommerce.com) or from Actian directly.

    
It is good practice to create and activate a virtual environment for your 
python projects. Once you have your environment activated (if you are
using one) install ``pyngres`` from PyPI:

.. CODE:: text

    pip install pyngres

Verify that Pyngres is installed and is able to discover the Actian
OpenAPI on your system. Do this by starting Python and importing pyngres.

..  FIGURE:: install-check-shot.png

If there are no error messages when it is imported then ``pyngres`` 
has discovered the OpenAPI and is ready for use.