Skip to content

Commit 1786567

Browse files
committed
Add CONTRIBUTING.md
1 parent cd6c193 commit 1786567

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

CONTRIBUTING.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Contributing to libSQL Python SDK
2+
3+
## Developing
4+
5+
Setup the development environment:
6+
7+
```sh
8+
python3 -m venv .env
9+
source .env/bin/activate
10+
pip3 install maturin pyperf pytest
11+
```
12+
13+
Or you can use NIX to drop you into a shell with everything installed
14+
15+
```
16+
nix-shell
17+
```
18+
19+
Build the development version and use it:
20+
21+
```
22+
maturin develop && python3 example.py
23+
```
24+
25+
Run the tests:
26+
27+
```sh
28+
pytest
29+
```
30+
31+
Run the libSQL benchmarks:
32+
33+
```sh
34+
python3 perf-libsql.py
35+
```
36+
37+
Run the SQLite benchmarks for comparison:
38+
39+
```sh
40+
python3 perf-sqlite3.py
41+
```

0 commit comments

Comments
 (0)