Metadata-Version: 2.1
Name: cerberus-api-client
Version: 1.0.0
Summary: A Python package to scrape OpenShift/Kubernetes cluster failures
Home-page: https://github.com/openshift-scale/cerberus-api-client
Author: Yashashree Suresh
Author-email: ysuresh@redhat.com
License: mit
Description: # Cerberus API Client
        
        A Python package to scrape OpenShift/Kubernetes cluster failures stored in SQLite database. It can be used with the [Cerberus](https://github.com/openshift-scale/cerberus) tool.
        
        ### Submodules
        
        #### cerberus_api_client.client.custom_query_loopback module
        `custom_query_loopback(database, loopback=60, issue="", name="", component="")`
        
        Retrieve the failures satisfying the criteria specified by parameters in the past `loopback` minutes in the json format.
        
        Parameters:
        - database: (str) Path where cerberus database is stored.
        - loopback: (int) Time in minutes.
        - issue: (list) A list of issue types.
        - name: (list) A list of component names (e.g. pod names, node names).
        - component: (list) A list of component types.
        
        #### cerberus_api_client.client.custom_query_interval module
        `custom_query_interval(database, start_time="", finish_time="", issue="", name="", component="")`
        
        Retrieve the failures between `start_time` and `finish_time` that satisfy the criteria specified by parameters in the json format.
        
        Parameters:
        - database: (str) Path where cerberus database is stored.
        - start_time: (timestamp) Timestamp in `%Y-%m-%d %H:%M:%S` format.
        - finish_time: (timestamp) Timestamp in `%Y-%m-%d %H:%M:%S` format.
        - issue: (list) A list of issue types.
        - name: (list) A list of component names (e.g. pod names, node names).
        - component: (list) A list of component types.
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown; charset=UTF-8
