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

4
+
5
+
## 🚀 About
6
+
**Arnelify® ORM for Python** - is a minimalistic dynamic library which is an ORM written in C and C++.
7
+
8
+
## 📋 Minimal Requirements
9
+
> Important: It's strongly recommended to use in a container that has been built from the gcc v14.2.0 image.
10
+
* CPU: Apple M1 / Intel Core i7 / AMD Ryzen 7
11
+
* OS: Debian 11 / MacOS 15 / Windows 10 with <ahref="https://learn.microsoft.com/en-us/windows/wsl/install">WSL2</a>.
12
+
* RAM: 4 GB
13
+
14
+
## 📦 Installation
15
+
Installing via pip:
16
+
```
17
+
pip install arnelify-orm
18
+
```
19
+
## 🎉 Usage
20
+
Install dependencies:
21
+
```
22
+
make install
23
+
```
24
+
Compile library:
25
+
```
26
+
make build
27
+
```
28
+
Compile & Run test:
29
+
```
30
+
make test_nuitka
31
+
```
32
+
Run test:
33
+
```
34
+
make test
35
+
```
36
+
## 📚 Code Examples
37
+
Configure the C/C++ IntelliSense plugin for VSCode (optional).
38
+
```
39
+
Clang_format_fallback = Google
40
+
```
41
+
42
+
IncludePath for VSCode (optional):
43
+
```
44
+
"includePath": [
45
+
"/opt/homebrew/opt/jsoncpp/include/json",
46
+
"/opt/homebrew/opt/mysql-client/include"
47
+
],
48
+
```
49
+
You can find code examples <ahref="https://github.com/arnelify/arnelify-orm-python/blob/main/tests/index.py">here</a>.
50
+
51
+
## ⚖️ MIT License
52
+
This software is licensed under the <ahref="https://github.com/arnelify/arnelify-orm-python/blob/main/LICENSE">MIT License</a>. The original author's name, logo, and the original name of the software must be included in all copies or substantial portions of the software.
53
+
54
+
## 🛠️ Contributing
55
+
Join us to help improve this software, fix bugs or implement new functionality. Active participation will help keep the software up-to-date, reliable, and aligned with the needs of its users.
56
+
57
+
## ⭐ Release Notes
58
+
Version 0.6.1 - Minimalistic dynamic library
59
+
60
+
We are excited to introduce the Arnelify ORM dynamic library for Python! Please note that this version is raw and still in active development.
61
+
62
+
Change log:
63
+
64
+
* Minimalistic dynamic library
65
+
* NodeJS (Bun) addon
66
+
* FFI Support
67
+
68
+
Please use this version with caution, as it may contain bugs and unfinished features. We are actively working on improving and expanding the ORM's capabilities, and we welcome your feedback and suggestions.
69
+
70
+
## 🔗 Mentioned
71
+
72
+
* <ahref="https://github.com/arnelify/arnelify-pod-cpp">Arnelify POD for C++</a>
73
+
* <ahref="https://github.com/arnelify/arnelify-pod-python">Arnelify POD for Python</a>
74
+
* <ahref="https://github.com/arnelify/arnelify-pod-node">Arnelify POD for NodeJS</a>
0 commit comments