lib/aiodatalite
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
hhh
2024-03-17 17:26:03 +02:00
parent bb2b5e6a4f
commit fe1554045e
11 changed files with 152 additions and 98 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/installation.rst
View File

@@ -1,10 +1,12 @@
Getting Started
=================
Welcome to the documentation of datalite. Datalite provides a simple, intuitive way to bind dataclasses
to sqlite3 databases. In its current version, it provides implicit support for conversion between
``int``, ``float``, ``str``, ``bytes`` classes and their ``sqlite3`` counterparts, default values,
Welcome to the documentation of aiodatalite, an asynchronous fork of datalite. Datalite provides a simple, intuitive
way to bind dataclasses to sqlite3 databases. In its current version, it provides implicit support for conversion
between ``int``, ``float``, ``str``, ``bytes`` classes and their ``sqlite3`` counterparts, default values,
basic schema migration and fetching functions.
Also, aiodatalite introduces ``tweaked`` parameter (True by default), which allows using pickle to store any values
in database
Installation
############
@@ -13,11 +15,11 @@ Simply write:
.. code-block:: bash
pip install datalite
pip install aiodatalite
In the shell. And then, whenever you want to use it in Python, you can use:
.. code-block:: python
import datalite
import aiodatalite