Nebulon Python SDK
==============================================

.. toctree::
   :hidden:

   installation
   quick_start
   api
   changelog


Overview
--------

The Nebulon Python SDK is a client library for nebulon ON written in
Python 3. It allows working with Nebulon nPods just like with the nebulon
ON web user interface but in a scriptable form.

As an alternative to using the Python SDK, customers can chose to use
GraphQL natively to interact with nebulon ON. This project is merely
a wrapper around the nebulon ON GraphQL API. For specifics on nebulon
resources and architecture, consult the Ultimate Guide to Cloud-Defined
Storage.

This documentation should be supplemental and attempts to explain the
installation procedure of the SDK, getting started with the SDK, and
provides details of teh exposed APIs.

:doc:`installation`
   How to obtain a copy of the source code, build instructions, and how
   to install the python package.

:doc:`quick_start`
   A quick start guide for the Nebulon Python SDK client

:doc:`api`
   A detailed explanation of all exposed APIs in the Python SDK


Community
---------

To learn what other #nebNerds are doing with the Nebulon Python SDK client,
to share an implementation or contribute code, or to interact with other
#nebNerds, visit the `Nebulon Community Slack <https://slack.nebulon.com/>`_.


Changelog
---------

See the :doc:`changelog` for a list or changes.


License
-------

This code is licensed under the MIT license. See the LICENSE file in
the root directory of the repository for details.


Indices and tables
==================

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