1
1
ObjectBox Python API
2
2
====================
3
-
4
- [ ObjectBox] ( https://objectbox.io ) is a superfast database for objects, now also available for Python with a simple CRUD API.
5
-
6
- * Python version: 3.4+
7
- * Platforms supported:
8
- * Linux x86-64 (64-bit)
9
- * Linux ARMv6hf (e.g. Raspberry PI Zero)
10
- * Linux ARMv7hf (e.g. Raspberry PI 3)
11
- * MacOS x86-64 (64-bit)
12
- * MacOS arm64 (Apple silicon)
13
- * Windows x86-64 (64-bit)
14
-
3
+ [ ObjectBox] ( https://objectbox.io ) is a superfast database for objects, now also available for Python (3.4+) with a simple CRUD API.
4
+ And because it's an embedded database, there's no setup required.
5
+
15
6
## Table of Contents:
16
7
- [ Getting Started] ( #getting-started )
17
8
- [ Model IDs and UIDs] ( #model-ids-and-uids )
@@ -27,7 +18,6 @@ ObjectBox Python API
27
18
28
19
Getting started
29
20
---------------
30
-
31
21
First of all, install the latest version:
32
22
33
23
``` bash
@@ -122,13 +112,18 @@ For more information and code examples, see the tests folder. The docs for other
122
112
123
113
Some features
124
114
-------------
125
-
126
- * automatic transactions (ACID compliant)
127
- * bulk operations
115
+ * Automatic transactions (ACID compliant)
116
+ * Bulk operations
117
+ * Vector types, e.g. for AI vector embeddings
118
+ * Platforms supported with native speed:
119
+ * Linux x86-64 (64-bit)
120
+ * Linux ARMv6hf (e.g. Raspberry PI Zero)
121
+ * Linux ARMv7hf (e.g. Raspberry PI 3; available only on request)
122
+ * MacOS x86-64 and arm64 (Intel 64-bit and Apple Silicon)
123
+ * Windows x86-64 (64-bit)
128
124
129
125
Coming in the future
130
126
--------------------
131
-
132
127
The goodness you know from the other ObjectBox language-bindings, e.g.,
133
128
134
129
* model management (no need to manually set id/uid)
@@ -140,23 +135,21 @@ The goodness you know from the other ObjectBox language-bindings, e.g.,
140
135
141
136
Help wanted
142
137
-----------
143
-
144
- ObjectBox for Python is still in an early stage with limited feature set (compared to other languages).
138
+ ObjectBox for Python is still in an early stage with limited feature set (compared to our other supported languages).
145
139
To bring all these features to Python, we're asking the community to help out. PRs are more than welcome!
146
140
The ObjectBox team will try its best to guide you and answer questions.
147
141
See [ CONTRIBUTING.md] ( https://github.com/objectbox/objectbox-python/blob/main/CONTRIBUTING.md ) to get started.
148
142
149
143
Feedback
150
144
--------
151
-
152
145
Also, please let us know your feedback by opening an issue: for example, if you experience errors or if you have ideas
153
146
for how to improve the API. Thanks!
154
147
155
148
License
156
149
-------
157
150
158
151
``` text
159
- Copyright 2019-2021 ObjectBox Ltd. All rights reserved.
152
+ Copyright 2019-2023 ObjectBox Ltd. All rights reserved.
160
153
161
154
Licensed under the Apache License, Version 2.0 (the "License");
162
155
you may not use this file except in compliance with the License.
0 commit comments