Metadata-Version: 2.1
Name: ods
Version: 0.0.3
Summary: Python client library for Staroid cloud platform
Home-page: https://github.com/open-datastudio/ods
Author: Open Data Studio
Author-email: moon@staroid.com
License: MIT
Description: <br />
        <center>
          <img src="https://github.com/open-datastudio/datastudio/raw/master/docs/_static/open-datastudio-logo.png" width="250px"/>
        </center>
        <br />
        
        # Open data studio python library
        
        
        ## Install
        
        ```
        pip install ods
        ```
        
        
        ## Quick start
        
        ### Initialize
        
        1. Login staroid.com and get an [access token](https://staroid.com/settings/accesstokens). And set `STAROID_ACCESS_TOKEN` environment variable. See [here](https://github.com/staroids/staroid-python#configuration) for more detail.
        2. Login staroid.com and create a SKE (Star Kubernetes engine) cluster.
        
        ```python
        import ods
        # 'ske' is the name of kubernetes cluster created from staroid.com. Alternatively, you can export 'STAROID_SKE' environment variable.
        ods.init(ske="kube-cluster-1")
        ```
        
        ## Spark
        
        ### Create spark session
        Create spark session with default configuration
        
        ```python
        import ods
        spark = ods.spark("spark-1") # 'spark-1' is name of spark-serverless instance to create.
        df = spark.createDataFrame(....)
        ```
        
        Configurue initial number of worker nodes
        
        ```python
        import ods
        spark = ods.spark("spark-1", worker_num=3).session()
        df = spark.createDataFrame(....)
        ```
        
        `detal=True` to automatically download & configure delta lake
        
        ```python
        import ods
        spark = ods.spark("spark-delta", delta=True)
        spark.read.format("delta").load(....)
        ```
        
        pass `spark_conf` dictionary for additonal configuration
        
        ```python
        import ods
        spark = ods.spark(spark_conf = {
            "spark.hadoop.fs.s3a.access.key": "...",
            "spark.hadoop.fs.s3a.secret.key" : "..."
        })
        ```
        
        Check [tests/test_spark.py](https://github.com/open-datastudio/ods/blob/master/tests/test_spark.py) as well.
        
        ## Dask
        
        Coming soon 🚛
        
        ```python
        import ods
        cluster = ods.dask("dask-1", worker_num=10)
        
        from dask.distributed import Client
        client = Client(cluster)
        ```
        
        ## Ray
        
        Coming soon 🚛
        
        ```python
        import ods
        ods.ray(cluster_name="")
        ```
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
