Skip to content

Commit ca52ffc

Browse files
committed
Update README
1 parent 1849833 commit ca52ffc

File tree

2 files changed

+67
-1
lines changed

2 files changed

+67
-1
lines changed

LICENSE.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
MIT License
2+
3+
Copyright 2023 the libSQL authors
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy of
6+
this software and associated documentation files (the "Software"), to deal in
7+
the Software without restriction, including without limitation the rights to
8+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
9+
the Software, and to permit persons to whom the Software is furnished to do so,
10+
subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
17+
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
18+
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
19+
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20+
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

+47-1
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,45 @@
11
# libSQL API for Python
22

3+
[![PyPI](https://badge.fury.io/py/libsql-experimental.svg)](https://badge.fury.io/py/libsql-experimental)
4+
5+
libSQL is an open source, open contribution fork of SQLite. We aim to evolve it to suit many more use cases than SQLite was originally designed for.
6+
7+
This source repository contains libSQL API bindings for Python, which aim to be compatible with the [sqlite3](https://docs.python.org/3/library/sqlite3.html) module.
8+
9+
## Install
10+
11+
You can install the current release _(MacOS and Linux)_:
12+
13+
```
14+
$ pip install libsql-experimental
15+
```
16+
317
## Getting Started
418

19+
To try out your first libsql program, start the Python interpreter:
20+
21+
```shell
22+
$ python
23+
```
24+
25+
and then:
26+
27+
```python
28+
>>> import libsql_experimental as libsql
29+
>>> con = libsql.connect("hello.db")
30+
>>> cur = con.cursor()
31+
>>> cur.execute("CREATE TABLE users (id INTEGER, email TEXT);")
32+
<builtins.Result object at 0x102dcf8d0>
33+
>>> cur.execute("INSERT INTO users VALUES (1, 'alice@example.org')")
34+
<builtins.Result object at 0x102dcf4b0>
35+
>>> cur.execute("SELECT * FROM users").fetchone()
36+
(1, 'alice@example.org')
37+
```
38+
539
#### Connecting to a database
640

741
```python
8-
import libsql
42+
import libsql_experimental as libsql
943

1044
con = libsql.connect("hello.db")
1145
cur = con.cursor()
@@ -62,3 +96,15 @@ Run the SQLite benchmarks for comparison:
6296
```sh
6397
python3 perf-sqlite3.py
6498
```
99+
100+
## License
101+
102+
This project is licensed under the [MIT license].
103+
104+
### Contribution
105+
106+
Unless you explicitly state otherwise, any contribution intentionally submitted
107+
for inclusion in libSQL by you, shall be licensed as MIT, without any additional
108+
terms or conditions.
109+
110+
[MIT license]: https://github.com/libsql/libsql-experimental-python/blob/main/LICENSE.md

0 commit comments

Comments
 (0)