Skip to content

Commit 72725a8

Browse files
committed
Merge branch 'dev'
2 parents e65e993 + f26ed25 commit 72725a8

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed

example/README.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,29 @@
11
# ObjectBox-Python Examples
22

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+
420

521
## Application Example: Tasks
622

723
This is our classic Tasks application using a CLI.
824

925
```
10-
cd example
11-
python -m tasks
26+
$ python -m tasks
1227
1328
Welcome to the ObjectBox tasks-list app example. Type help or ? for a list of commands.
1429
> new buy oat
@@ -36,7 +51,8 @@ This example application starts with a pre-defined set of capital cities and the
3651
It allows to search for nearest neighbors of a city (`city_neighbors`) or by coordinates (`neighbors`) as well as adding more locations (`add`).
3752

3853
```
39-
python -m vectorsearch-cities
54+
$ python -m vectorsearch-cities
55+
4056
Welcome to the ObjectBox vectorsearch-cities example. Type help or ? for a list of commands.
4157
> ls
4258
ID Name Latitude Longitude

0 commit comments

Comments
 (0)