Metadata-Version: 2.1
Name: superb-ai-label
Version: 0.19.0
Summary: Suite Standard Library
Home-page: https://github.com/Superb-AI-Suite/superb-ai-curate-python.git
Author: Superb AI Dev Team
Author-email: support@superb-ai.com
License: MIT
Description: <!-- <p align="center">
          <a href="http://suite-api.superb-ai.com/" target="blank"><img src="logo/cool-tree.png" width="200" height="200" alt="Cool-Tree Logo" /></a>
        </p> -->
        
        # Superb AI Suite Software Development Kit
        
        ![Build](https://github.com/Superb-AI-Suite/spb-cli/workflows/Build/badge.svg)
        ![Version](https://img.shields.io/pypi/v/spb-cli)
        [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
        <!--![Unit Test](https://github.com/Superb-AI-Suite/cool-tree/workflows/Unit%20Test/badge.svg)-->
        
        
        Official Superb AI Suite Software Development Kit for managing data and labels on [Superb AI Suite](https://suite.superb-ai.com).
        
        - [Installation](#Installation)
        - [Authentication](#Authentication)
        - [Resource Description](#Resource-Description)
            - [Projects](#Projects)
            - [Labels](#Labels)
        - [Contributing](#Contributing)
        - [License](#License)
        
        ## Installation
        
        ```shell
        $ pip install spb-sdk
        
        0.0.xx
        ``` 
        
        ## Authentication
        
        You need an *Access Key* for authentication. The *Access Key* can be generated on the :tada: [Superb AI Suite web](https://suite.superb-ai.com/) (Suite > My Account > Advanced).
        
        You can then configure your profile by entering your *Suite Team Name* and the generated *Access Key* to under configuration file.
        
        :rotating_light: ***Suite Team Name* refers to the organization name that your personal account belongs to:**
        
        <img src="./assets/account-name.png" width="400">
        
        ```shell
        $ cat <<EOF >> ~/.spb/config
        [default]
        team_name = YOUR TEAM NAME
        access_key = GENERATED TEAM ACCESS KEY
        EOF
        ```
        
        ## Resource Description
        
        ### Projects
        
        ```python
        from spb_label import sdk
        
        client = sdk.Client()
        # Get all projects
        count, projects = client.get_projects()
        # Set project to client what to handle
        client.set_project(projects[0])
        # Get project name and id
        client.get_project_name()
        client.get_project_id()
        
        # Get all project users
        count, users = client.get_project_users()
        
        # Get project tags
        count, tags = client.get_project_tags()
        ```
        ### Labels
        ```python
        from spb_label import sdk
        from spb_label.utils import SearchFilter
        
        client = sdk.Client()
        client.set_project(name="YOUR PROJECT NAME")
        
        # Get labels
        filter = SearchFilter(project=client.project)
        
        # Status filter
        filter.status_is_any_one_of = ["WORKING", "SKIPPED"]
        # Assignee filter
        filter.assignee_is_any_one_of = ["ASSIGNEE EMAIL"]
        # Tag filter
        filter.tag_name_all = ["TAG NAME"]
        
        count, labels, next = client.get_labels(
          filter=filter,
          cursor=next
        )
        ```
        
        ## Contributing
        
        Feel free to report issues and suggest improvements.  
        Please email us at support@superb-ai.com
        
        ## License
        
        The MIT License (MIT)
        
        Copyright (c) 2020, Superb AI, Inc.
        
        Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
        
Platform: UNKNOWN
Classifier: Development Status :: 1 - Planning
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Description-Content-Type: text/markdown
