Vertex Protocol Python SDK
==========================

This is the Python SDK for the `Vertex Protocol API <https://vertex-protocol.gitbook.io/docs/developer-resources/api>`_.

The latest version of the SDK can be found on `PyPI <https://pypi.org/project/vertex-protocol/>`_, and the source code is on `GitHub <https://github.com/vertex-protocol/vertex-python-sdk>`_.

.. NOTE::

   👋 Brand new to Vertex?

   0. Join the Vertex community via `Discord <https://discord.gg/vertexprotocol>`_, `Twitter <https://twitter.com/vertex_protocol>`_.
   1. Read our `docs <https://vertex-protocol.gitbook.io/docs/getting-started/overview>`_ to learn the basic concepts.
   2. Visit us at `Vertex Protocol <https://vertexprotocol.com/>`_.
   3. The :ref:`getting-started` section will give you a quick idea of the core things you can do via the SDK!

Requirements
------------

- Python 3.9 or above

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

You can install the SDK via pip:

.. code-block:: bash

    pip install vertex-protocol

You might want to use a virtual environment to isolate your packages.

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

   getting-started
   user-reference
   user-guides
   api-reference