Welcome to puchikarui’s documentation!¶
Welcome to puchikarui’s documentation!
A minimalist SQLite helper library for Python 3 which supports ORM features.
Installation¶
puchikarui
is available on
PyPI and can be installed
using pip
.
pip install puchikarui
Sample code¶
from puchikarui import Database
INIT_SCRIPT = '''
CREATE TABLE person (
ID INTEGER PRIMARY KEY AUTOINCREMENT,
name TEXT,
age INTEGER
);
'''
class PeopleDB(Database):
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.add_script(INIT_SCRIPT)
self.add_table('person', ['ID', 'name', 'age'], id_cols=('ID',))
db = PeopleDB('test.db')
people = db.person.select()
# create sample people records in the first run
if not people:
print("Creating people records ...")
for name, age in zip('ABCDE', range(20, 25)):
db.person.insert(f'Person {name}', age)
people = db.person.select()
print("All people")
print("----------------------")
for person in people:
print(person.ID, person.name, person.age)
For more examples please see the demo files
python3 demo_helloworld.py
python3 demo_orm.py
Why puchikarui¶
puchikarui
is a tiny, 100% pure-Python library that provides extra
functionality to Python 3’s
sqlite3 module. It
helps working directly with sqlite3
easier, with less magic, and
more control, rather than hiding sqlite3 module away from the users.
Although puchikarui
does provide some ORM-like features, it is NOT
an ORM library. If you want ORM features, please consider
PonyORM,
SQLAlchemy, or
peewee.
Meaning¶
The name puchikarui
came from two Japanese words プチ
(puchi)
which means small, and 軽い
(karui), which means light, soft, and
gentle.
It represents the motivation for developing this library: a tiny,
lightweight library that makes working with sqlite3
simpler.
$ python3 -m jamdict lookup "プチ"
========================================
Found entries
========================================
Entry: 1115200 | Kj: | Kn: プチ
--------------------
1. small ((prefix))
$ python3 -m jamdict lookup "軽い"
========================================
Found entries
========================================
Entry: 1252560 | Kj: 軽い | Kn: かるい, かろい
--------------------
1. light (i.e. not heavy)/feeling light (i.e. offering little resistance, moving easily) ((adjective (keiyoushi)))
2. light (i.e. of foot)/effortless/nimble/agile ((adjective (keiyoushi)))
3. non-serious/minor/unimportant/trivial ((adjective (keiyoushi)))
4. slight/small/gentle/soft/easy/lighthearted (e.g. joke) ((adjective (keiyoushi)))
5. easy/simple ((adjective (keiyoushi)))
6. indiscriminate ((adjective (keiyoushi)))