.. digital-world-py-sdk documentation master file, created by
   sphinx-quickstart on Sat Jan 20 11:58:02 2018.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Digital World Python SDK
==================

.. container:: badges

   .. image:: https://img.shields.io/badge/pypi%20package-15.0.0-2757dd
      :target: https://pypi.org/project/digital-world-sdk/
      :alt: PyPI package version

   .. image:: https://img.shields.io/badge/python-3.10%2B-2757dd
      :alt: Supported Python versions

   .. image:: https://img.shields.io/badge/license-Apache%202.0-2757dd
      :target: https://github.com/DigitalWorld/digital-world-py-sdk/blob/master/LICENSE
      :alt: License

digital-world-py-sdk is a Python library for communicating with
a `Digital World Gateway server`_ and `DWSA RPC server`_. It is used for building Digital World apps on Python. It supports **Python 3.10+** as
well as PyPy 3.11.

It provides:

- a networking layer API for Gateway endpoints.
- a networking layer API for DWSA RPC server methods.
- facilities for building and signing transactions, for communicating with a Digital World Gateway and DWSA-RPC instance, and for submitting transactions or querying network history.

Quickstart
----------
At the absolute basics, you'll want to read up on `Digital World's Documentation
Guides <https://docs.digitalworld.global/docs/>`_, as it contains a lot of
information on the concepts used below (Transactions, Payments, Operations,
KeyPairs, etc.).

.. toctree::
   :maxdepth: 2
   :caption: Guides

   guides/00-install
   guides/01-generate-keypair
   guides/02-create-account-and-fund
   guides/03-query-and-stream
   guides/04-issue-an-asset
   guides/05-building-transactions
   guides/06-send-a-payment
   guides/07-asynchronous
   guides/08-multi-signature-account


API Documentation
-----------------
Here you'll find detailed documentation on specific functions, classes, and
methods.

.. toctree::
   :maxdepth: 2
   :caption: Reference

   reference/core-xdr
   reference/api

digital-world-model
-------------
digital-world-model allows you to parse the JSON returned by Digital World Gateway
into the Python models, click `here <https://github.com/DigitalWorld/digital-world-model>`__ for more information.

Links
-----
* Document: https://digital-world-sdk.readthedocs.io
* Code: https://github.com/DigitalWorld/digital-world-py-sdk
* Examples: https://github.com/DigitalWorld/digital-world-py-sdk/tree/main/examples
* Issue tracker: https://github.com/DigitalWorld/digital-world-py-sdk/issues
* License: `Apache License 2.0 <https://github.com/DigitalWorld/digital-world-py-sdk/blob/master/LICENSE>`_
* Releases: https://pypi.org/project/digital-world-sdk/

:ref:`genindex`
---------------


.. _here: https://github.com/DigitalWorld/digital-world-py-sdk/tree/master/examples
.. _Digital World Gateway server: https://github.com/digitalworld/gateway
.. _pip: https://pip.pypa.io/en/stable/quickstart/
.. _Digital World JavaScript SDK: https://gitlab.com/digitalworld/digital-world-js-sdk
.. _DWSA RPC server: https://dex.digitalworld.global/docs/reference/rpc