Metadata-Version: 2.1
Name: ascend-io-sdk
Version: 0.2.55
Summary: The Ascend.io SDK for Python
Home-page: https://www.ascend.io
License: Apache-2.0
Keywords: ascend,pipeline,data,automation,platform
Author: Ascend.io Engineering
Author-email: support@ascend.io
Maintainer: Ascend.io Engineering
Maintainer-email: support@ascend.io
Requires-Python: >=3.7,<4.0
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: Jinja2 (>=3.1.1,<4.0.0)
Requires-Dist: backoff (>=1.10.0,<2.0.0)
Requires-Dist: chardet (==3.0.4)
Requires-Dist: glog (>=0.3.1,<0.4.0)
Requires-Dist: googleapis-common-protos (==1.56.4)
Requires-Dist: idna (==2.10)
Requires-Dist: networkx (>=2.5,<3.0)
Requires-Dist: protobuf (==3.20.1)
Requires-Dist: python-dateutil (>=2.8.1,<3.0.0)
Requires-Dist: requests (>=2.25.1,<3.0.0)
Requires-Dist: retry (>=0.9.2,<0.10.0)
Requires-Dist: six (==1.16.0)
Requires-Dist: toml (==0.10.1)
Requires-Dist: urllib3 (>=1.26.5,<2.0.0)
Project-URL: Ascend.io, https://www.ascend.io
Project-URL: Ascend Developer, https://developer.ascend.io
Project-URL: Documentation, https://developer.ascend.io/docs/python-sdk
Description-Content-Type: text/x-rst

.. raw::html
    <hidden>test</hidde>

==============================
The Ascend.io Python SDK
==============================

This package contains the `Ascend Python SDK <https://developer.ascend.io/docs/python-sdk>`_. This SDK is used to script the management of the
`Ascend.io <https://www.ascend.io>`_ Data Automation Platform. The SDK can be used to create your own customizations of the
platform configuration, integrate with   CI/CD or other tools, as well as fully automate your environment.

* **Automation.** Integrate Ascend with any combination of workflow and/or CI/CD tools your organization uses on a daily basis.
* **Transparency.** Ascend deploys within your Cloud tenant (GCP, AWS, Azure) so you can see everything the platform is doing.
* **Control.** Manage your Ascend Platform, build dataflows, extract metadata, and more in a completely programmatic way

---------------
Get Started
---------------
You will need access to an Ascend.io installation. Developers can `sign up for a free trial <https://www.ascend.io/signup/>`_.
If you are already an Ascend customer, have your administrator add you to the platform.

Once you have access to the Platform, `create your developer API Access Keys <https://developer.ascend.io/docs/developer-keys>`_
and `configure your local authentication file <https://developer.ascend.io/docs/python-sdk#authorization>`_. Remember to change
the word *trial* in your local authentication file to the name of your Ascend.io instance.


Install the python library using `pip <https://pip.pypa.io/en/latest/>`_::

    $ pip3 install ascend-io-sdk

Start writing your automations with the `Python Client <https://developer.ascend.io/docs/python-sdk-client-ref>`_.

------------------
Run the Examples
------------------
If running some sample code works for you, try out the Ascend Python SDK by listing the dataflows
within your Ascend instance::

    from ascend.sdk.client import Client
    from tabulate import tabulate

    hostname = 'my-host-name'
    client = Client(hostname)
    services = []
    for ds in client.list_data_services().data:
        services.append([ds.id, ds.name, ds.created_at, ds.updated_at])

    print(tabulate(sorted(services, key=lambda x: x[1]), headers=["id", "name", "created at"]))

We release updates to the SDK all the time. If some features are missing, you get stuck, or you find
something that you don't think is right, please let us know. We're here to make the developer experience
as easy and enjoyable as possible. We know that fabulous Developer Relations is key!

---------------
Read the Docs
---------------
* `Ascend.io Python SDK Documentation <https://developer.ascend.io/docs/python-sdk>`_
* `Ascend Developer Hub <https://developer.ascend.io>`_
* `Ascend.io <https://www.ascend.io>`_


