@@ -23,9 +23,9 @@ The model consists of Python classes annotated with `@Entity` decorator.
2323### Model IDs and UIDs
2424Each Entity has to have an ID (unique among entities).
2525Properties need an ID as well (unique inside one Entity).
26- Both Entities and Properties must also have an UID which is a globally unique identifier.
26+ Both Entities and Properties must also have an UID, which is a globally unique identifier.
2727
28- For other ObjectBox supported languages the binding takes care of assigning these IDs/UIDs but this feature is not yet implemented for Python.
28+ For other ObjectBox supported languages, the binding takes care of assigning these IDs/UIDs but this feature is not yet implemented for Python.
2929To learn more, see ObjectBox Java documentation: https://docs.objectbox.io/advanced/meta-model-ids-and-uids
3030
3131#### model.py
@@ -41,14 +41,14 @@ class Person:
4141
4242### Using ObjectBox
4343To actually use the database, you launch (or "build") it with the model you've just defined.
44- Afterwards, you can reuse the instance (` ob ` in the example bellow ) and use it to access "Entity Boxes" which hold your objects.
44+ Afterwards, you can reuse the instance (` ob ` in the example below ) and use it to access "Entity Boxes" which hold your objects.
4545
4646#### program.py
4747``` python
4848import objectbox
4949# from mypackage.model import Person
5050
51- # Configure ObjectBox - should be done only once in the whole program and the "ob" variable should be kept around
51+ # Configure ObjectBox: should be done only once in the whole program and the "ob" variable should be kept around
5252model = objectbox.Model()
5353model.entity(Person, last_property_id = objectbox.model.IdUid(3 , 1003 ))
5454model.last_entity_id = objectbox.model.IdUid(1 , 1 )
@@ -64,7 +64,7 @@ box.put(person) # Update
6464box.remove(person) # Delete
6565```
6666
67- For more information and code examples see the tests folder as well as docs for other languages which may help you understand the basics.
67+ For more information and code examples, see the tests folder. The docs for other languages may also help you understand the basics.
6868* ObjectBox Java = https://docs.objectbox.io
6969* ObjectBox Go - https://golang.objectbox.io
7070* ObjectBox Swift - https://swift.objectbox.io
@@ -76,7 +76,7 @@ Some features
7676
7777Coming in the future
7878-------------
79- The goodness you know from other language-bindings ObjectBox has , e.g.:
79+ The goodness you know from the other ObjectBox language-bindings, e.g.,
8080* model management (no need to manually set id/uid)
8181* automatic model migration (no schema upgrade scripts etc.)
8282* powerful queries
@@ -86,8 +86,8 @@ The goodness you know from other language-bindings ObjectBox has, e.g.:
8686
8787Contributing
8888------------
89- Currently, the Python binding is in it's very early stages and lots of features available in other languages is missing here .
90- If you have requests for specific feature, please open an issue. If you want to contribute, please feel free to open a PR.
89+ Currently, the Python binding is in its very early stages and lots of features available in other languages are missing.
90+ If you have a request for a specific feature, please open an issue. If you want to contribute, please feel free to open a PR.
9191In case it's a non-obvious contribution it might be better to discuss and align first in an issue.
9292
9393This repo uses ` virtualenv ` when installing packages so in case you don't have it yet: ` pip install virtualenv ` .
0 commit comments