added usage example and minor fixes (#10)

NASA-IMPACT · Aug 25, 2023 · 241eaea · 241eaea
1 parent 02f6e30
commit 241eaea
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -11,9 +11,38 @@ A python library to handle communication with Sinequa REST API.
 ```
    $ pip install pynequa
 ```
+
+## Example Usage
+```
+import pynequa 
+from pynequa.models import QueryParams
+
+# provide following config parameters 
+config = {
+   "base_url": "", 
+   "app_name": "", 
+   "access_token":"",
+   "query_name": ""
+}
+
+#initialize a Sinequa connector instance 
+sinequa=pynequa.Sinequa(config=config)
+
+params = QueryParams()
+params.search_text = "<your_search_text>"
+..... #other params 
+
+#perform a search query operation 
+results=sinequa.search_query(params)
+```
+
+
 ## Feature Roadmap 
 Implement following REST endpoints to manage requests with Sinequa API. 
 
+
+
+
 **Search Endpoints:**
 - [x] search.app 
 - [x] search.dataset

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [project]
 name = "pynequa"
-version = "0.1.0"
+version = "0.1.1"
 authors = [
   { name="Anish Bhusal", email="[email protected]" },
 ]

diff --git a/requirements.txt b/requirements.txt
@@ -1,3 +1,3 @@
-pytest==7.1.1
+Requests==2.31.0
 setuptools==61.2.0
 sphinx-click==4.4.0
diff --git a/setup.py b/setup.py
@@ -1,6 +1,6 @@
 from setuptools import setup, find_packages
 
-VERSION = '0.1.0'
+VERSION = '0.1.1'
 requirements = []
 test_requirements = ['pytest>=3']