sedb 0.1.1__tar.gz

sedb-0.1.1/PKG-INFO

@@ -0,0 +1,56 @@
+Metadata-Version: 2.1
+Name: sedb
+Version: 0.1.1
+Summary: Search Engine DataBase utils
+Author: Hansimov
+Project-URL: Homepage, https://github.com/Hansimov/tclogger
+Project-URL: Issues, https://github.com/Hansimov/tclogger/issues
+Project-URL: Changelog, https://github.com/Hansimov/tclogger/blob/main/CHANGELOG.md
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+Requires-Dist: tclogger
+Requires-Dist: pymongo
+Requires-Dist: elasticsearch
+
+# sedb
+Search Engine DataBase utils
+
+![](https://img.shields.io/pypi/v/sedb?label=sedb&color=blue&cacheSeconds=60)
+
+## Install
+```sh
+pip install sedb --upgrade
+```
+
+## Usage
+
+Run example:
+
+```sh
+python example.py
+```
+
+See: [example.py](./example.py)
+
+```python
+import sys
+from pathlib import Path
+
+sys.path.insert(0, str(Path(__file__).parent / "src"))
+
+import bldb
+
+from bldb import MongoOperator, MongoConfigsType
+
+
+if __name__ == "__main__":
+    mongo_configs = {
+        "host": "localhost",
+        "port": 27017,
+        "dbname": "test",
+    }
+    mongo = MongoOperator(configs=mongo_configs)
+```

sedb-0.1.1/README.md

@@ -0,0 +1,39 @@
+# sedb
+Search Engine DataBase utils
+
+![](https://img.shields.io/pypi/v/sedb?label=sedb&color=blue&cacheSeconds=60)
+
+## Install
+```sh
+pip install sedb --upgrade
+```
+
+## Usage
+
+Run example:
+
+```sh
+python example.py
+```
+
+See: [example.py](./example.py)
+
+```python
+import sys
+from pathlib import Path
+
+sys.path.insert(0, str(Path(__file__).parent / "src"))
+
+import bldb
+
+from bldb import MongoOperator, MongoConfigsType
+
+
+if __name__ == "__main__":
+    mongo_configs = {
+        "host": "localhost",
+        "port": 27017,
+        "dbname": "test",
+    }
+    mongo = MongoOperator(configs=mongo_configs)
+```

sedb-0.1.1/pyproject.toml

@@ -0,0 +1,20 @@
+[project]
+name = "sedb"
+version = "0.1.1"
+authors = [
+    { name="Hansimov" },
+]
+description = "Search Engine DataBase utils"
+readme = "README.md"
+requires-python = ">=3.6"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+dependencies = [ "tclogger", "pymongo", "elasticsearch" ]
+
+[project.urls]
+Homepage = "https://github.com/Hansimov/tclogger"
+Issues = "https://github.com/Hansimov/tclogger/issues"
+Changelog = "https://github.com/Hansimov/tclogger/blob/main/CHANGELOG.md"

sedb-0.1.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

sedb-0.1.1/src/sedb/__init__.py

@@ -0,0 +1,2 @@
+from .mongo import MongoOperator, MongoConfigsType
+from .elastic import ElasticOperator, ElasticConfigsType

sedb-0.1.1/src/sedb/elastic.py

@@ -0,0 +1,54 @@
+from elasticsearch import Elasticsearch
+from tclogger import logger, logstr
+from typing import TypedDict
+
+
+class ElasticConfigsType(TypedDict):
+    host: str
+    port: int
+    ca_certs: str
+    api_key: str
+
+
+class ElasticOperator:
+    def __init__(self, configs: ElasticConfigsType, verbose: bool = True):
+        self.configs = configs
+        self.init_configs()
+        self.verbose = verbose
+
+    def init_configs(self):
+        self.host = self.configs["host"]
+        self.port = self.configs["port"]
+        self.ca_certs = self.configs["ca_certs"]
+        self.api_key = self.configs["api_key"]
+        self.endpoint = f"https://{self.host}:{self.port}"
+
+    def connect(self):
+        """Connect to self-managed cluster with API Key authentication
+        * https://www.elastic.co/guide/en/elasticsearch/client/python-api/current/connecting.html#auth-apikey
+
+        How to create API Key:
+        - Go to Kibana: http://<hostname>:5601/app/management/security/api_keys
+        - Create API Key, which would generated a json with keys "name", "api_key" and "encoded"
+        - Use "encoded" value for the `api_key` param in Elasticsearch class below
+
+        Connect to self-managed cluster with HTTP Bearer authentication
+        * https://www.elastic.co/guide/en/elasticsearch/client/python-api/current/connecting.html#auth-bearer
+        """
+        if self.verbose:
+            logger.note(
+                f"> Connecting to Elasticsearch: "
+                f"{logstr.mesg('['+self.endpoint+']')}"
+            )
+        try:
+            self.client = Elasticsearch(
+                hosts=self.endpoint,
+                ca_certs=self.ca_certs,
+                api_key=self.api_key,
+                # basic_auth=(self.username, self.password),
+            )
+            if self.verbose:
+                logger.success(f"+ Connected:")
+                logger.mesg(self.client.info())
+        except Exception as e:
+            raise e

sedb-0.1.1/src/sedb/mongo.py

@@ -0,0 +1,123 @@
+import pymongo
+import threading
+
+from pathlib import Path
+from tclogger import logger, logstr, FileLogger
+from tclogger import get_now_str, ts_to_str, dict_to_str
+from typing import Literal, Union, TypedDict
+
+
+class MongoConfigsType(TypedDict):
+    host: str
+    port: int
+    dbname: str
+
+
+class MongoOperator:
+    def __init__(
+        self,
+        configs: MongoConfigsType,
+        connect_at_init: bool = True,
+        connect_msg: str = None,
+        lock: threading.Lock = None,
+        log_path: Union[str, Path] = None,
+        verbose: bool = True,
+    ):
+        self.configs = configs
+        self.verbose = verbose
+        self.init_configs()
+        self.connect_at_init = connect_at_init
+        self.connect_msg = connect_msg
+        self.lock = lock or threading.Lock()
+        if log_path:
+            self.file_logger = FileLogger(log_path)
+        else:
+            self.file_logger = None
+        if self.connect_at_init:
+            self.connect(connect_msg=connect_msg)
+
+    def init_configs(self):
+        self.host = self.configs["host"]
+        self.port = self.configs["port"]
+        self.dbname = self.configs["dbname"]
+        self.endpoint = f"mongodb://{self.host}:{self.port}"
+
+    def connect(self, connect_msg: str = None):
+        connect_msg = connect_msg or self.connect_msg
+        if self.verbose:
+            logger.note(f"> Connecting to: {logstr.mesg('['+self.endpoint+']')}")
+            logger.file(f"  * {get_now_str()}")
+            if connect_msg:
+                logger.file(f"  * {connect_msg}")
+        self.client = pymongo.MongoClient(self.endpoint)
+        try:
+            self.db = self.client[self.dbname]
+            if self.verbose:
+                logger.file(f"  * database: {logstr.success(self.dbname)}")
+        except Exception as e:
+            raise e
+
+    def log_error(self, docs: list = None, e: Exception = None):
+        error_info = {"datetime": get_now_str(), "doc": docs, "error": repr(e)}
+        if self.verbose:
+            logger.err(f"× Mongo Error: {logstr.warn(error_info)}")
+        if self.file_logger:
+            error_str = dict_to_str(error_info, is_colored=False)
+            self.file_logger.log(error_str, "error")
+
+    def get_cursor(
+        self,
+        collection: str,
+        filter_index: str = None,
+        filter_op: Literal["gt", "lt", "gte", "lte", "range"] = "gte",
+        filter_range: Union[int, str, tuple, list] = None,
+        sort_index: str = None,
+        sort_order: Literal["asc", "desc"] = "asc",
+        verbose: bool = False,
+    ):
+        if verbose:
+            args_dict = {
+                "collection": collection,
+                "filter_index": filter_index,
+                "filter_op": filter_op,
+                "filter_range": filter_range,
+                "sort_index": sort_index,
+                "sort_order": sort_order,
+            }
+            if filter_index and filter_index.lower() in ["pubdate", "insert_at"]:
+                if isinstance(filter_range, (tuple, list)):
+                    filter_range_str = [ts_to_str(i) for i in filter_range]
+                elif isinstance(filter_range, int):
+                    filter_range_str = ts_to_str(filter_range)
+                else:
+                    filter_range_str = filter_range
+                args_dict["filter_range_str"] = filter_range_str
+            if self.verbose:
+                logger.note(f"> Getting cursor with args:")
+                logger.mesg(dict_to_str(args_dict), indent=2)
+
+        filter = {}
+        if filter_index:
+            if filter_op == "range":
+                if filter_range and isinstance(filter_range, (tuple, list)):
+                    filter[filter_index] = {
+                        "$gte": min(filter_range),
+                        "$lte": max(filter_range),
+                    }
+                else:
+                    raise ValueError(f"× Invalid filter_range: {filter_range}")
+            elif filter_op in ["gt", "lt", "gte", "lte"]:
+                filter[filter_index] = {f"${filter_op}": filter_range}
+            else:
+                raise ValueError(f"× Invalid filter_op: {filter_op}")
+
+        cursor = self.db[collection].find(filter)
+
+        if sort_index:
+            if sort_order and sort_order.lower().startswith("desc"):
+                order = pymongo.DESCENDING
+            else:
+                order = pymongo.ASCENDING
+            cursor = cursor.sort(sort_index, order)
+
+        return cursor

sedb-0.1.1/src/sedb.egg-info/PKG-INFO

@@ -0,0 +1,56 @@
+Metadata-Version: 2.1
+Name: sedb
+Version: 0.1.1
+Summary: Search Engine DataBase utils
+Author: Hansimov
+Project-URL: Homepage, https://github.com/Hansimov/tclogger
+Project-URL: Issues, https://github.com/Hansimov/tclogger/issues
+Project-URL: Changelog, https://github.com/Hansimov/tclogger/blob/main/CHANGELOG.md
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+Requires-Dist: tclogger
+Requires-Dist: pymongo
+Requires-Dist: elasticsearch
+
+# sedb
+Search Engine DataBase utils
+
+![](https://img.shields.io/pypi/v/sedb?label=sedb&color=blue&cacheSeconds=60)
+
+## Install
+```sh
+pip install sedb --upgrade
+```
+
+## Usage
+
+Run example:
+
+```sh
+python example.py
+```
+
+See: [example.py](./example.py)
+
+```python
+import sys
+from pathlib import Path
+
+sys.path.insert(0, str(Path(__file__).parent / "src"))
+
+import bldb
+
+from bldb import MongoOperator, MongoConfigsType
+
+
+if __name__ == "__main__":
+    mongo_configs = {
+        "host": "localhost",
+        "port": 27017,
+        "dbname": "test",
+    }
+    mongo = MongoOperator(configs=mongo_configs)
+```

sedb-0.1.1/src/sedb.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+README.md
+pyproject.toml
+src/sedb/__init__.py
+src/sedb/elastic.py
+src/sedb/mongo.py
+src/sedb.egg-info/PKG-INFO
+src/sedb.egg-info/SOURCES.txt
+src/sedb.egg-info/dependency_links.txt
+src/sedb.egg-info/requires.txt
+src/sedb.egg-info/top_level.txt

sedb-0.1.1/src/sedb.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

sedb-0.1.1/src/sedb.egg-info/requires.txt

@@ -0,0 +1,3 @@
+tclogger
+pymongo
+elasticsearch

sedb-0.1.1/src/sedb.egg-info/top_level.txt

@@ -0,0 +1 @@
+sedb