.. VeraCore API Client documentation master file, created by
   sphinx-quickstart on Sun Jun 13 09:54:17 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to the VeraCore API Python Client's Documentation!
==========================================================

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

   user_guide/examples


API Documentation
-----------------
You can find out more regarding the API in the `Official VeraCore.com REST API Documentation`_

.. _Official VeraCore.com REST API Documentation: https://support.veracore.com/support/s/apiobject

The Swagger documentation can be found here: :samp:`https://{domain}.veracore.com/VeraCore/Public.Api/swagger/ui/index`

* Replace `{domain}` with your VeraCore domain name


Authors & License
--------------------------

This package is released under an open source GNU General Public License v3 or later (GPLv3+) license. This package was originally created by Eli Keimig.

The latest build status can be found at `Travis CI`_

.. _Eli Keimig: https://github.com/cyclops26
.. _GitHub Repo: https://github.com/VeraCore-API/veracore-api-client-python
.. _Travis CI: https://travis-ci.com/VeraCore-API/veracore-api-client-python


Indices & Tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`