Metadata-Version: 2.1
Name: redash-api-client
Version: 0.1.0
Summary: Redash API Client
Home-page: https://github.com/damnee562/redash-api-client
Author: Damien Zeng
Author-email: damnee562@gmail.com
License: UNKNOWN
Description: # Redash-API-Client
        Redash API Client written in Python.
        
        ## Dependencies
        * Python3.6+
        
        ## Installation
        Install using pip:
        
            pip install redash-api-client
        
        ## Getting Started
        ```python
        from redash.client import RedashClient
        
        """
            :args:
            API_KEY
            REDASH_HOST (optional): 'http://localhost:5000' by default
        """
        Redash = RedashClient(API_KEY, REDASH_HOST)
        
        # Connect to a Data Source
        """
            :args:
            DATA_SOURCE_NAME
            DATA_SOURCE_TYPE: ["sqlite", "mysql", "pg", "mongodb", "mssql" ...]
            OPTIONS
        """
        Redash.connect_data_source("First Data Source", "pg", {
            "dbname": DB_NAME,
            "host": DB_HOST,
            "user": DB_USER,
            "passwd": DB_PASSWORD,
            "port": DB_PORT
        })
        
        # Create Query
        """
            :args:
            QUERY_NAME
            DATA_SOURCE_ID
            QUERY_STRING
            WITH_RESULT (optional): Generate query_result automatically, True by default
        """
        Redash.create_query("First Query", 1, "SELECT * FROM table_name;", False)
        
        # Generate Query Result
        """
            :args:
            DATA_SOURCE_ID
            QUERY_STRING
            QUERY_ID
        """
        Redash.generate_query_result(1, "SELECT * FROM table_name;", 1)
        
        # Create Visualization
        """
            :args:
            NAME
            QUERY_ID
            CHART_TYPE: ["line", "column", "area", "pie", "scatter", "bubble", "box"]
            X_AXIS_COLUMN
            Y_AXIS_COLUMN
            Y_LABEL (optional): Custom name for legend
        """
        Redash.create_visualization("First Visualization", 1, "line", X_AXIS_COLUMN, Y_AXIS_COLUMN, Y_LABEL)
        
        # Create Dashboard
        """
            :args:
            NAME
        """
        Redash.create_dashboard("First Dashboard")
        
        # Add Visualization into Dashboard
        """
            :args:
            DASHBOARD_ID
            VISUALIZATION_ID
            FULL_WIDTH (optional): Full width or not on dashboard, False by default
        """
        Redash.add_to_dashboard(1, 1, True)
        
        # Get Dashboard public URL
        """
            :args:
            DASHBOARD_ID
        """
        url = Redash.get_dashboard_public_url(1)
        ```
        
        ## License
        This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.6
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
