You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: example/README.md
+20-4Lines changed: 20 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,29 @@
1
1
# ObjectBox-Python Examples
2
2
3
-
The following examples are available from this repository.
3
+
This directory contains a couple of examples that demonstrate capabilities of ObjectBox using the Python API.
4
+
5
+
As we are currently short before releasing 4.0 version, please install the pre-release version of `objectbox` from PyPI via `pip`; for example, on UN*X-flavour platforms:
6
+
7
+
```shell
8
+
cd example # assuming you are in project root dir
9
+
python3 -m venv venv
10
+
source venv/bin/activate
11
+
pip install --pre objectbox
12
+
```
13
+
14
+
The following examples are available from this directory:
15
+
16
+
-`tasks`: CRUD Application Example (see below for details)
17
+
-`vectorsearch-cities`: VectorSearch Application Example (see below for details)
18
+
-`ollama`: LLM + VectorSearch Embeddings Script Example (See [ollama/README.md](./ollama/README.md) for details)
19
+
4
20
5
21
## Application Example: Tasks
6
22
7
23
This is our classic Tasks application using a CLI.
8
24
9
25
```
10
-
cd example
11
-
python -m tasks
26
+
$ python -m tasks
12
27
13
28
Welcome to the ObjectBox tasks-list app example. Type help or ? for a list of commands.
14
29
> new buy oat
@@ -36,7 +51,8 @@ This example application starts with a pre-defined set of capital cities and the
36
51
It allows to search for nearest neighbors of a city (`city_neighbors`) or by coordinates (`neighbors`) as well as adding more locations (`add`).
37
52
38
53
```
39
-
python -m vectorsearch-cities
54
+
$ python -m vectorsearch-cities
55
+
40
56
Welcome to the ObjectBox vectorsearch-cities example. Type help or ? for a list of commands.
0 commit comments