Merge branch '56-flatten-model-api' into 'dev'

Resolve "Integrated Model API into Top-Level API"

See merge request objectbox/objectbox-python!46

Author: dan-obx

README.md

@@ -43,12 +43,15 @@ Feature Highlights
 What does using ObjectBox in Python look like?
 
 ```python
-import objectbox
+from objectbox import *
 
-# from mypackage.model import Person
+@Entity()
+class Person:
+    id = Id
+    name = String
 
 # The ObjectBox Store represents a database; keep it around...
-store = objectbox.Store(model=model)
+store = Store()
 
 # Get a box for the "Person" entity; a Box is the main interaction point with objects and the database.
 box = store.box(Person)

example/ollama/main.py

@@ -2,9 +2,7 @@
 # using objectbox as a vector store
 
 import ollama
-import objectbox
-from objectbox.model import *
-from objectbox.model.properties import *
+from objectbox import *
 
 documents = [
   "Llamas are members of the camelid family meaning they're pretty closely related to vicuñas and camels",
@@ -16,7 +14,7 @@
 ]
 
 # Have fresh data for each start
-objectbox.Store.remove_db_files("objectbox")
+Store.remove_db_files("objectbox")
 
 @Entity()
 class DocumentEmbedding:
@@ -27,7 +25,7 @@ class DocumentEmbedding:
         distance_type=VectorDistanceType.COSINE
     ))
 
-store = objectbox.Store()
+store = Store()
 box = store.box(DocumentEmbedding)
 
 print("Documents to embed: ", len(documents))

example/tasks/main.py

@@ -1,6 +1,5 @@
 from cmd import Cmd
-import objectbox
-from objectbox.model import *
+from objectbox import *
 import time
 
 @Entity()
@@ -24,7 +23,7 @@ def format_date(timestamp_ms: int) -> str:
 
 class TasklistCmd(Cmd):
     prompt = "> "
-    _store = objectbox.Store(directory="tasklist-db")
+    _store = Store(directory="tasklist-db")
     _box = _store.box(Task)
 
     def do_ls(self, _):

example/vectorsearch-cities/main.py

@@ -1,6 +1,5 @@
 from cmd import Cmd
-import objectbox
-from objectbox.model import *
+from objectbox import *
 import time
 import csv
 import os
@@ -32,7 +31,7 @@ def __init__(self, *args):
         Cmd.__init__(self, *args)
         dbdir = "cities-db"
         new_db = not os.path.exists(dbdir)
-        self._store = objectbox.Store(directory=dbdir)
+        self._store = Store(directory=dbdir)
         self._box = self._store.box(City)
         if new_db: 
             with open(os.path.join(os.path.dirname(__file__), 'cities.csv')) as f:

objectbox/__init__.py

@@ -15,7 +15,7 @@
 
 from objectbox.box import Box
 from objectbox.builder import Builder
-from objectbox.model import Model
+from objectbox.model import Model, Entity, Id, String, Index, Bool, Int8, Int16, Int32, Int64, Float32, Float64, Bytes, BoolVector, Int8Vector, Int16Vector, Int32Vector, Int64Vector, Float32Vector, Float64Vector, CharVector, BoolList, Int8List, Int16List, Int32List, Int64List, Float32List, Float64List, CharList, Date, DateNano, Flex, HnswIndex, VectorDistanceType
 from objectbox.store import Store
 from objectbox.objectbox import ObjectBox
 from objectbox.c import NotFoundException, version_core, DebugFlags
@@ -25,6 +25,39 @@
     'Box',
     'Builder',
     'Model',
+    'Entity',
+    'Id',
+    'Bool',
+    'Int8',
+    'Int16',
+    'Int32',
+    'Int64',
+    'Float32',
+    'Float64',
+    'Bytes',
+    'String',
+    'BoolVector',
+    'Int8Vector',
+    'Int16Vector',
+    'Int32Vector',
+    'Int64Vector',
+    'Float32Vector',
+    'Float64Vector',
+    'CharVector',
+    'BoolList',
+    'Int8List',
+    'Int16List',
+    'Int32List',
+    'Int64List',
+    'Float32List',
+    'Float64List',
+    'CharList',
+    'Date',
+    'DateNano',
+    'Flex',
+    'Index',
+    'HnswIndex',
+    'VectorDistanceType',
     'Store',
     'ObjectBox',
     'NotFoundException',

tests/common.py

@@ -2,11 +2,10 @@
 import pytest
 import objectbox
 from objectbox.logger import logger
-from objectbox.store import Store
 from tests.model import *
 import numpy as np
-from datetime import timezone
-
+from datetime import datetime, timezone
+from objectbox import *
 
 def remove_json_model_file():
     path = os.path.dirname(os.path.realpath(__file__))
@@ -16,7 +15,7 @@ def remove_json_model_file():
 
 
 def create_default_model():
-    model = objectbox.Model()
+    model = Model()
     model.entity(TestEntity)
     model.entity(TestEntityDatetime)
     model.entity(TestEntityFlex)

tests/model.py

@@ -1,6 +1,4 @@
-from objectbox.model import *
-from datetime import datetime
-
+from objectbox import *
 
 @Entity()
 class TestEntity:

tests/test_internals.py

@@ -1,5 +1,4 @@
 from objectbox import *
-from objectbox.model import *
 from objectbox.model.idsync import sync_model
 
 import os

tests/test_query.py

@@ -1,6 +1,5 @@
 import objectbox
 from objectbox import *
-from objectbox.model import *
 from objectbox.c import *
 from objectbox.query import *
 import pytest

tests/test_userclass.py

@@ -1,5 +1,4 @@
 from objectbox import *
-from objectbox.model import *
 from objectbox.model.idsync import sync_model
 
 def test_userclass():