Metadata-Version: 2.1
Name: sonic-client
Version: 0.0.3
Summary: python client for sonic search backend
Home-page: https://github.com/xmonader/python-sonic-client
Author: Ahmed T. Youssef
Author-email: xmonader@gmail.com
License: BSD 3-Clause License
Description: # python-sonic-client
        
        Python client for [sonic](https://github.com/valeriansaliou/sonic) search backend.
        
        ## Install
        
        ```
        pip install sonic-client
        ```
        
        ## Examples
        
        ### Ingest 
        
        ```python
        from sonic import IngestClient
        
        with IngestClient("127.0.0.1", 1491, "password") as ingestcl:
            print(ingestcl.ping())
            print(ingestcl.protocol)
            print(ingestcl.bufsize)
            ingestcl.push("wiki", "articles", "article-1", "for the love of god hell")
            ingestcl.push("wiki", "articles", "article-2", "for the love of satan heaven")
            ingestcl.push("wiki", "articles", "article-3", "for the love of lorde hello")
            ingestcl.push("wiki", "articles", "article-4", "for the god of loaf helmet")
        ```
        
        
        ### Search
        
        ```python
        from sonic import SearchClient
        
        with SearchClient("127.0.0.1", 1491, "password") as querycl:
            print(querycl.ping())
            print(querycl.query("wiki", "articles", "for"))
            print(querycl.query("wiki", "articles", "love"))
            print(querycl.suggest("wiki", "articles", "hell"))
        ```
        
        
        ### Control
        
        ```python
        from sonic import ControlClient
        
        with ControlClient("127.0.0.1", 1491, "password") as controlcl:
            print(controlcl.ping())
            controlcl.trigger("consolidate")
        ```
        
        ## Difference from asonic
        
        asonic uses asyncio and this client doesn't. It grew out of needing to use sonic within gevent context  
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Description-Content-Type: text/markdown
