.. Strangeworks Module Reference documentation master file, created by
   sphinx-quickstart on Tue Feb  1 14:56:57 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to the Strangeworks Python SDK documentation!
=========================================================

The Strangeworks Python SDK offers access to the Strangeworks platform API. To get an account sign up at `strangeworks.com <https://strangeworks.com>`_. For access to hardware and other resources sign up for our `Back Stage Pass <https://strangeworks.com/backstage>`_. For more information see our general `docs <https://docs.strangeworks.com>`_.

To get started you will need to install the SDK and authenticate using your API key.

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

The Strangeworks SDK is installed using pip ::

    pip install -U pip && pip install strangeworks


Test your installation by running the following ::

    $ python
    >>> import strangeworks
    >>> print(strangeworks.__version__)

Authentication
--------------

Authenticate using the ``strangeworks.authenticate()`` method ::

   $ python
   >>> import strangeworks
   >>> strangeworks.authenticate(api_key="<your-api-key>")

Python SDK Module Reference
---------------------------

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

   modules