added readme and setup.py

Author: RedSnail

README.md

@@ -0,0 +1,7 @@
+# Typesense-orm
+This is an ORM client for typesense-server. It is still under construction (now only write operations work)
+### Installation
+
+### Description
+This client has aiohttp under the hood, but you can specify a mode (see example) and work in either a synchronized manner, or in an async mode.<br/>
+The ORM is based on pydantic here (actually models are inherited from pydantic base model with some methods overriden). (to be continued)

examples/basic_example.py

@@ -1,8 +1,4 @@
-from typesense_orm.api_caller import ApiCallerAsync, Node, ApiCallerSync
-from typesense_orm.base_model import create_base_model
-from typesense_orm.field import Field
-from typesense_orm.types import int32
-from typesense_orm.higher_client import Client
+from typesense_orm import ApiCallerAsync, Node, ApiCallerSync, create_base_model, Field, int32, Client
 from typing import List, get_args
 
 node = Node(url="http://localhost:8108")
@@ -26,9 +22,9 @@ class Config:
 
 book1 = Books(title="harry potter", year=2001)
 book2 = Books(title="hp 2", year=2002)
-# it = client.import_json(Books, [book1.json(exclude_unset=True), book2.json(exclude_unset=True)], schedule=True, name="import_task", action="upsert")
 it = client.import_objects([book1, book2])
 for i in it:
     print(i)
+print(Books.title)
 
 client.close()

requirements.txt

@@ -0,0 +1,19 @@
+aiohttp==3.8.1
+aiologger==0.6.1
+aiosignal==1.2.0
+async-timeout==4.0.2
+asyncstdlib==3.10.5
+attrs==21.4.0
+charset-normalizer==2.0.12
+frozenlist==1.3.0
+idna==3.3
+multidict==6.0.2
+mypy-extensions==0.4.3
+nest-asyncio==1.5.5
+pip==21.3.1
+pydantic==1.9.1
+setuptools==60.2.0
+typing-extensions==4.2.0
+typing-inspect==0.7.1
+wheel==0.37.1
+yarl==1.7.2

setup.py

@@ -0,0 +1,32 @@
+import typesense_orm
+from setuptools import setup, find_packages
+
+
+def parse_requirements(requirements):
+    with open(requirements, "r") as req_file:
+        return [line.strip('\n') for line in req_file if line.strip('\n')
+                and not line.startswith('#')]
+
+
+requires = parse_requirements("requirements.txt")
+
+with open('README.md') as f:
+    long_description = f.read()
+
+setup(
+    name="typesense_orm",
+    packages=find_packages(),
+    version=typesense_orm.__version__,
+    description="A typesense-server client using orm paradigm based on pydantic",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    author="Oleg Demianchenko",
+    author_email="oleg.demianchenko@gmail.com",
+    license="MIT",
+    platforms="OS Independent",
+    url="https://github.com/RedSnail/typesense_orm",
+    python_requires='>=3.8',
+    include_package_data=False,
+    install_requires=requires
+)
+

typesense_orm/__init__.py

@@ -1,3 +1,11 @@
 import nest_asyncio
+from .api_caller import Node, ApiCallerSync, ApiCallerAsync, ApiCaller
+from .higher_client import Client
+from .field import Field
+from .base_model import create_base_model
+from .types import int32, int64
 
 nest_asyncio.apply()
+__version__ = "0.0.1"
+
+

typesense_orm/base_model.py

@@ -19,11 +19,11 @@ class ModelMetaclass(pydantic.main.ModelMetaclass):
     def to_schema(cls) -> Schema:
         field_dict = cls.__fields__.copy()
         field_dict.pop("id", None)
-        fields = list(map(lambda field: FieldArgs(name=field.name,
-                                                  type=field.type_,
-                                                  index=field.field_info.extra.get("index", False),
-                                                  facet=field.field_info.extra.get("facet", False),
-                                                  optional=field.field_info.extra.get("optional", True)),
+        fields = dict(map(lambda field: (field.name, FieldArgs(name=field.name,
+                                                               type=field.type_,
+                                                               index=field.field_info.extra.get("index", False),
+                                                               facet=field.field_info.extra.get("facet", False),
+                                                               optional=field.field_info.extra.get("optional", True))),
                           field_dict.values()))
         schema = Schema(name=cls.schema_name,
                         fields=fields,
@@ -33,6 +33,12 @@ def to_schema(cls) -> Schema:
 
         return schema
 
+    def __getattr__(cls, item):
+        res = cls.schema.fields.get(item, None)
+        if res:
+            return res
+        super().__getattr__(item)
+
     @property
     def endpoint_path(cls):
         return f"{COLLECTIONS_PATH}/{cls.schema_name}/{DOC_ENDPOINT}"
@@ -62,7 +68,8 @@ def __new__(mcs, name, bases, namespace, **kwargs):
                     namespace.update({"__client__": client})
                     break
 
-            client.create_collection(ret.to_schema())
+            ret.schema = ret.to_schema()
+            client.create_collection(ret.schema)
 
         return ret
 

typesense_orm/schema.py

@@ -5,19 +5,20 @@
 
 
 def json_dumper(v, *, default):
-    for field in v["fields"]:
+    for field in v["fields"].values():
         _, field_type = get_from_opt(field["type"])
         field["type"] = allowed_types[field_type]
 
+    v["fields"] = list(v["fields"].values())
     return json.dumps(v)
 
 
 def json_loader(js_string):
     js_dict = json.loads(js_string)
-    fields = []
+    fields = {}
     for field in js_dict["fields"]:
         field["type"] = allowed_types_rev[field["type"]]
-        fields.append(FieldArgs(**field))
+        fields.update({field["name"]: FieldArgs(**field)})
 
     js_dict["fields"] = fields
     return js_dict
@@ -33,7 +34,7 @@ class FieldArgs(BaseModel):
 
 class Schema(BaseModel):
     name: str
-    fields: Sequence[FieldArgs]
+    fields: Dict[str, FieldArgs]
     token_separators: Optional[Sequence[str]]
     symbols_to_index: Optional[Sequence[str]]
     default_sorting_field: Optional[str]
@@ -47,7 +48,7 @@ def from_dict(cls, dict_schema: Dict[str, Any]):
             field["type"] = allowed_types_rev[field["type"]]
             fields.append(FieldArgs(**field))
 
-        dict_schema["fields"] = fields
+        dict_schema["fields"] = dict(map(lambda f: (f["name"], f), dict_schema["fields"]))
         return cls(**dict_schema)
 
     class Config: