Privex's Python Database helpers and wrappers (mini ORM)
Project description
Privex's Python Database Library
+===================================================+
| © 2019 Privex Inc. |
| https://www.privex.io |
+===================================================+
| |
| Privex's Python Database Library |
| License: X11 / MIT |
| |
| Originally Developed by Privex Inc. |
| Core Developer(s): |
| |
| (+) Chris (@someguy123) [Privex] |
| |
+===================================================+
Privex's Python Database Library - Database wrappers, query builders, and other useful DB-related classes/functions
Copyright (c) 2019 Privex Inc. ( https://www.privex.io )
README under construction.
Install with pip
We recommend at least Python 3.6 - we cannot guarantee compatibility with older versions.
pip3 install privex-db
Basic Usage
Basic usage with SqliteWrapper
and SqliteBuilder
(db.builder()
)
from os.path import expanduser
from privex.db import SqliteWrapper
# Open or create the database file ~/.my_app/my_app.db
db = SqliteWrapper(expanduser("~/.my_app/my_app.db"))
# Create the table 'items' and insert some items
db.action("CREATE TABLE items (id INTEGER PRIMARY KEY AUTOINCREMENT, name TEXT);")
db.action("INSERT INTO items (name) VALUES (?);", ["Cardboard Box"])
db.action("INSERT INTO items (name) VALUES (?);", ["Orange"])
db.action("INSERT INTO items (name) VALUES (?);", ["Banana"])
db.action("INSERT INTO items (name) VALUES (?);", ["Stack of Paper"])
item = db.fetchone("SELECT * FROM items WHERE name = ?", ['Orange'])
print(item.id, '-', item.name)
# Output: 2 - Orange
q = db.builder('items')
# Privex QueryBuilder's support chaining similar to Django's ORM
q.select('id', 'name') \ # SELECT id, name FROM items
.where('name', 'Orange') \ # WHERE name = 'Orange'
.where_or('name', 'Banana') \ # OR name = 'Banana'
.order('name', 'id') # ORDER BY name, id DESC
# You can either iterate directly over the query builder object
for row in q:
print(f"ID: {row.id} Name: {row.name}")
# Output:
# ID: 3 Name: Banana
# ID: 2 Name: Orange
# Or you can use .fetch / .all to grab a single row, or all rows as a list
item = db.builder('items').where('name', 'Orange').fetch()
# {'id': 2, 'name': 'Orange'}
items = db.builder('items').all()
# [ {'id': 1, 'name': 'Cardboard Box'}, {'id': 2, 'name': 'Orange'}, ... ]
Documentation
Full documentation for this project is available above (click the Read The Docs image), including:
- How to install the application and it's dependencies
- How to use the various functions and classes
- General documentation of the modules and classes for contributors
To build the documentation:
pip3 install pipenv
git clone https://github.com/Privex/python-db
cd python-db/docs
pipenv install -d
# It's recommended to run make clean to ensure old HTML files are removed
# `make html` generates the .html and static files in docs/build for production
make clean && make html
# After the files are built, you can live develop the docs using `make live`
# then browse to http://127.0.0.1:8100/
# If you have issues with content not showing up correctly, try make clean && make html
# then run make live again.
make live
Unit Tests
To run the unit tests, clone the project and make a .env
file containing details for a PostgreSQL database
(for the Postgres wrapper + builder tests).
DB_USER=yourname
DB_NAME=privex_py_db
DB_BACKEND=postgresql
LOG_LEVEL=DEBUG
Install all required dependencies:
pip3 install pipenv
pipenv install -d
Now run the tests (-v for more detailed testing output):
pipenv run pytest -rxXs -v
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
privex_db-0.9.2.tar.gz
(38.9 kB
view hashes)
Built Distribution
privex_db-0.9.2-py3-none-any.whl
(47.3 kB
view hashes)
Close
Hashes for privex_db-0.9.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7158831693bd426f8c380cc015cb5771e79ec70564e9063dd27592aafb88b236 |
|
MD5 | c6f356d78164d6237824601e11769fea |
|
BLAKE2b-256 | 1ca5056cef9fbdff9c02bc0773040cd0efcbd376e8588a54fc05629c6a55c37f |