Metadata-Version: 2.1
Name: pyops
Version: 0.0.2
Summary: OpenSearch python client.
Home-page: https://github.com/devsf/pyops
Author: Sergio Ferraresi
Author-email: dev@sergioferraresi.it
License: Apache2.0
Description: 
        pyops: OpenSearch made pythonically easy
        ===========================
        
        OpenSearch python client.
        
        Examples:
        ```python
        >>> import pyops
        >>> client = pyops.Client(description_xml_url="https://example.org")
        
        # simple search
        >>> raw_results = client.search()
        
        # authenticated search
        >>> raw_results = client.search(auth=('username', 'password'))
        
        # advanced search
        >>> raw_results = client.search(params={"{eop:instrument?}": {"value": "SAR"}})
        
        # results filtering
        >>> raw_results = client.search()
        >>> entry_fields = client.get_available_fields()
        >>>  filtered_results = client.filter_entries([{
        >>>     "tag": "{http://www.w3.org/2005/Atom}id",
        >>>     "name": "id"
        >>> }, {
        >>>     "tag": "{http://www.w3.org/2005/Atom}title",
        >>>     "name": "title"
        >>> }, {
        >>>     "tag": "{http://www.w3.org/2005/Atom}summary",
        >>>     "name": "summary"
        >>> }, {
        >>>     "tag": "{http://www.w3.org/2005/Atom}published",
        >>>     "name": "published"
        >>> }, {
        >>>     "tag": "{http://www.w3.org/2005/Atom}updated",
        >>>     "name": "updated"
        >>> }, {
        >>>     "tag": "{http://www.w3.org/2005/Atom}link",
        >>>     "name": "link",
        >>>     "rel": "enclosure"
        >>> }])
        ```
        
        TODO
        ----
        - APIs (search, ...)
        - documentation
        
        [HOW TO] DEPLOY
        ---------------
        Update `pyops.__version__.py`
        ```bash
        # create packages
        python3 setup.py sdist bdist_wheel
        # upload on test.pypi
        twine upload --repository-url https://test.pypi.org/legacy/ dist/*
        # test install
        python3 -m pip install --index-url https://test.pypi.org/simple/ pyops
        # upload on pypi
        twine upload dist/*
        ```
        
        CHANGELOG
        ---------
        
        * v0.0.2 (2019-07-16):
          * Added: authentication management
          * Bugfix: removed unused parameters from search (added regex)
          * Tests: added test_authentication (description_xml_url and authentication params not committed)
          * Issue #1: included tests in packaging
Keywords: opensearch geo search
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Operating System :: OS Independent
Requires-Python: >=2.7.0
Description-Content-Type: text/markdown
