Welcome to dataclasses_sqlitedict Documentation
Sqlite backed dataclasses. It is a light weight persistent storage for dataclasses. If you are looking for a full featured ORM, please check out SQLAlchemy.
Features
Single Row Data Model
Each instance of class is a row in the table. And all the instances of the same class share the same database table.
import dataclasses
from sqlitedict import SqliteDict
from dataclasses_sqlitedict import SingleRowDataModel
@dataclasses.dataclass
class User(SingleRowDataModel):
username: str
password: str
db = SqliteDict("user.sqlite", autocommit=False)
@property
def primary_key(self) -> str:
return self.username
user = User(username="alice", password="pwd")
user.write()
user1 = User.read("alice")
print(user1)
Single Table Data Model
Each instance of class is a table. Each instance of class could be different tables in the same databases, or different table in different databases.
import dataclasses
from sqlitedict import SqliteDict
from dataclasses_sqlitedict import SingleTableDataModel
@dataclasses.dataclass
class User(SingleTableDataModel):
username: str
password: str
db = SqliteDict("user.sqlite", autocommit=False)
user = User(db=db, username="alice", password="pwd")
user.write()
user1 = User.read(db)
print(user1)
Install
dataclasses_sqlitedict is released on PyPI, so all you need is:
$ pip install dataclasses_sqlitedict
To upgrade to latest version:
$ pip install --upgrade dataclasses_sqlitedict
Metadata
Release files for dataclasses-sqlitedict 0.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| dataclasses_sqlitedict-0.1.1.tar.gz | 7.9 kB | Without provenance | Details for dataclasses_sqlitedict-0.1.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| dataclasses_sqlitedict-0.1.1-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details for dataclasses_sqlitedict-0.1.1-py2.py3-none-any.whl |
Total release size: 15.2 kB
Release files / dataclasses_sqlitedict-0.1.1.tar.gz
| Download URL | dataclasses_sqlitedict-0.1.1.tar.gz |
|---|---|
| Size | 7.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a0f479b4c3508a30baa4d314d39bf1dda0f3c36763aba0917e05ee4a02a93557
|
|
BLAKE2b-256 checksum How to use checksums |
56c03e9cddb11a874a2c8b3067cf8ce7ca1c8a172a36e38b9c8cd76cab6f3803
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.8.11
|
Release files / dataclasses_sqlitedict-0.1.1-py2.py3-none-any.whl
| Download URL | dataclasses_sqlitedict-0.1.1-py2.py3-none-any.whl |
|---|---|
| Size | 7.3 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
8241e171b0ed34130593afc43e8cefad52a3be8a86bfd932f0f1f3b941547b39
|
|
BLAKE2b-256 checksum How to use checksums |
d2ad93e9c05bb43b496f87eaab5471a4a2d75f6a7fecec62bdd7ff6c10e369d7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.8.11
|
Security for dataclasses-sqlitedict 0.1.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.