Version 0.0.1

LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright 2018 Sergio Ferraresi
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

MANIFEST.in

@@ -0,0 +1 @@
+include README.md LICENSE

README.md

@@ -1,2 +1,55 @@
-# pyops
-OpenSearch python client
+pyops: OpenSearch made easy
+===========================
+
+OpenSearch python client.
+
+Examples:
+```python
+# simple example
+>>> import pyops
+>>> client = pyops.Client(repository_desx="https://example.org")
+>>> raw_results = client.search()
+
+# advanced search
+>>> raw_results = client.search(params={"{eop:instrument?}": {"value": "SAR"}})
+
+# advandced results filtering
+>>> 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
+```

pyops/__init__.py

@@ -0,0 +1 @@
+from .core import Client

pyops/__version__.py

@@ -0,0 +1,3 @@
+VERSION = (0, 0, 1)
+
+__version__ = '.'.join(map(str, VERSION))