devtools-shorthand-sql 0.3.0

Aid writing boilerplate SQL items from create tables, inserts and updates.

devtools_shorthand_sql

Overview

Aid for writing boilerplate python code for SQL work, including creation of tables, insert functions, unit testing and SQL, dependent on relational database management system selected.

• Documentation: https://devtools-shorthand-sql.readthedocs.io.

Features

• TODO

Requirements

You need Python 3.6 or later to run devtools_shorthand_sql.

No other third party packages are required.

Quickstart

Install the latest version of this software from the Python package index (PyPI):

pip install --upgrade devtools_shorthand_sql

Create a shorthand sql file e.g. shorthand.txt.

# table photo
size int
filename text
date_taken int

Run

devtools_shorthand_sql shorthand.txt

SQL statement for table creation:

CREATE TABLE IF NOT EXISTS photo (
id INTEGER PRIMARY KEY,
size int,
filename text,
date_taken int
);

Python function for data insertion:

def insert_photo(size: int, filename: str, date_taken: int) -> int:
    params = (None, size, filename, date_taken)
    id = YOUR_CONNECTOR_EXECUTOR("""INSERT INTO photo (id, size, filename, date_taken) VALUES(?,?,?,?);""",
                                 params)
    return id

Python function for unit testing:

def test_insert_photo(YOUR_CLEAN_DB_FIXTURE):
    expected = (1, 999, '123fakestreet', 999)
    YOUR_MODULE.insert_photo(size=999, filename="123fakestreet", date_taken=999)
    result = YOUR_CONNECTOR_QUERY('SELECT * FROM photo').fetchall()[0]
    assert result == expected