.. This is the prosuite documentation master file.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

===========================
Dira ProSuite Python Client
===========================

.. toctree::
   :maxdepth: 2
   :caption: Contents:
   :hidden:

   samples
   prosuite
   xmlspec

The Dira ProSuite Python Client is the Python API for the ProSuite Quality Verification Server. 
ProSuite is a suite of high-end productivity tools for data production, quality assurance, and cartographic refinement within ArcGIS

The ProSuite Python Client is a lightweight package that provides access to the ProSuite QA functionality through a pythonic API.
Quality specifications containing QA tests for geodata can be fully defined in Python and executed on a ProSuite server which 
runs either locally or on a remote machine. Alternatively, an existing XML specification can be executed with just a few lines of code.

Find out more about ProSuite at `Dira GeoSystems <https://www.dirageosystems.ch>`__.

System Requirements
===================
* Python Version >= 3.7
* A running ProSuite service, either on the local machine or on a remote server

Installation
============
The ProSuite Python Client API is installed by the standard Python Package Manager. Make sure to run 
Pip from the Python distribution/environment where you need ProSuite to be installed.

.. code-block:: python

    pip install prosuite

To get started, proceed to the :ref:`Samples <samples-link>` page.

API Reference
=============
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`