Velocity-Python
A rapid application development library for Python that eliminates boilerplate between your code and your database. Write business logic, not SQL plumbing.
@engine.transaction
def create_order(tx, customer_email, items):
customer = tx.table("customers").find({"email": customer_email})
order = tx.table("orders").insert({
"customer_id": customer["sys_id"],
"status": "pending",
"total": sum(i["price"] for i in items),
})
tx.table("order_items").insert_many([
{"order_id": order["sys_id"], "product": i["name"], "price": i["price"]}
for i in items
])
return order
No connection management, no cursor juggling, no commit/rollback boilerplate. Velocity handles it all.
Why Velocity?
Most Python database libraries fall into two camps:
-
Heavy ORMs (SQLAlchemy, Django ORM) — powerful but complex. You write Python classes that map to tables, manage sessions, deal with migration frameworks, and learn a large API surface before writing your first query.
-
Raw drivers (psycopg, sqlite3) — full control, but you're writing SQL strings, managing connections, handling cursors, serializing parameters, and building your own transaction/error-handling patterns from scratch.
Velocity occupies the middle ground: a thin, opinionated layer that gives you the convenience of an ORM with the transparency of raw SQL. Tables are just names. Rows are just dicts. Transactions are just context managers. You don't define models — Velocity discovers your schema at runtime and adapts to it.
Design Principles
| Principle | What It Means |
|---|---|
| Convention over configuration | Sensible defaults everywhere. Override only what you need. |
| Dicts in, dicts out | No custom model classes to learn. Rows are dictionaries. |
| Transaction-scoped | Every operation runs inside an explicit transaction. No surprise autocommit. |
| Auto-schema | Tables and columns are created on the fly in development. Locked down in production. |
| Driver-agnostic | PostgreSQL (primary), MySQL, SQLite, SQL Server — same API surface. |
| Lambda-native | Connection pooling, warm-start reuse, and SQS batch handling built in. |
Installation
# Core (no database driver — useful for testing or SQLite)
pip install velocity-python
# PostgreSQL (recommended)
pip install velocity-python[postgres]
# With AWS Lambda support
pip install velocity-python[postgres,aws]
# Everything
pip install velocity-python[all]
Available Extras
| Extra | Packages | Use Case |
|---|---|---|
postgres |
psycopg[binary]>=3.2.0 |
PostgreSQL connections |
aws |
boto3, requests |
Lambda handlers, SQS, Amplify |
excel |
openpyxl |
Excel export |
parquet |
pyarrow |
Parquet export |
ods |
odfpy |
OpenDocument spreadsheet export |
templates |
jinja2 |
Template rendering |
pdf |
weasyprint |
HTML → PDF rendering (native Pango/Cairo from the OS or a layer) |
http |
requests |
HTTP utilities |
payment |
stripe, braintree, xmltodict |
Stripe and Braintree adapters (Authorize.Net additionally needs authorizenet, installed separately — see docs/payment.md) |
mysql |
mysql-connector-python |
MySQL connections |
sqlserver |
python-tds |
SQL Server connections |
redis, mongodb, elasticsearch, cassandra, couchbase |
the matching client | NoSQL adapters (docs/nosql.md) |
all |
postgres, aws, excel, templates, http, payment, pdf |
Typical full install |
Requires Python 3.9+ and uses psycopg v3 (not psycopg2) for PostgreSQL.
Quick Start
1. Connect
from velocity.db.servers.postgres import initialize
# From environment variables (DBHost, DBDatabase, DBUser, DBPassword)
engine = initialize()
# Or explicit config
engine = initialize(config={
"host": "localhost",
"dbname": "myapp",
"user": "postgres",
"password": "secret",
})
2. Use Transactions
# As a decorator (recommended for Lambda handlers)
@engine.transaction
def get_active_users(tx):
return tx.table("users").select(where={"active": True}).all()
# As a context manager
with engine.transaction() as tx:
tx.table("users").insert({"name": "Alice", "email": "alice@example.com"})
3. CRUD Operations
@engine.transaction
def demo(tx):
users = tx.table("users")
# Insert
row = users.insert({"name": "Bob", "email": "bob@example.com"})
# Read
user = users.row(row["sys_id"]) # by primary key
user = users.find({"email": "bob@example.com"}) # by lookup
# Update
user["name"] = "Robert" # immediate write-through
# Delete
users.delete({"sys_id": row["sys_id"]})
4. Bulk Operations
@engine.transaction
def import_customers(tx, records):
tx.table("customers").insert_many(records) # multi-row INSERT
tx.table("customers").upsert_many(records, pk="email") # INSERT ... ON CONFLICT UPDATE
Documentation
Full documentation is included in the docs/ directory of the source distribution.
What changed in each release, and what callers must do before upgrading, is in
CHANGELOG.md (Breaking / Deploy ordering / Added / Fixed per version).
| Guide | File | Description |
|---|---|---|
| Database ORM | docs/database.md |
Connections, DB_TUNNEL, transactions, tables, rows, results, queries, purge, schema management |
| Schema Management | docs/schema-management.md |
Runtime auto-heal, declarative ensure_schema(), schema locking, conflict handling |
| Performance & Optimization | docs/performance.md |
Connection pooling, batch operations, query caching, prepared statements, N+1 prevention, observability |
| Async Support | docs/async.md |
AsyncTransaction, AsyncTable, AsyncResult, parallel queries with gather() |
| Configuration Reference | docs/configuration.md |
Every environment variable and SSM config key velocity reads, ssm_config, S3 buckets, engine options |
| AWS Lambda Handlers | docs/aws-handlers.md |
LambdaHandler, SqsHandler, auth modes, per-record transactions, DataService client boundary, async jobs (JobHandler + job result stores), failure events |
| AWS Auth Modes | docs/AWS_HANDLERS_AUTH.md |
Cognito auth, public endpoints, webhooks |
| Deployment | docs/deploy.md |
velocity.aws.deploy: least-privilege IAM, function settings, layers, SQS queue reconcile |
| Cross-database Mirroring | docs/mirroring.md |
Keep a table identical in two databases (demo ↔ production) by natural key; rwx hooks, FK translation, reconcile |
| Operations Dashboard | docs/operations.md |
What the automation is doing: schedules, jobs, failures, stuck work, with drill-down (velocity.aws.ops + velocity-react OpsDashboard) |
| NoSQL Adapters | docs/nosql.md |
Redis, DynamoDB, MongoDB, Elasticsearch, Cassandra, Couchbase behind one capability-honest contract |
| Payment Processing | docs/payment.md |
Stripe, Braintree and Authorize.Net adapters, processor mirrors, payment lifecycle |
| Utilities | docs/utilities.md |
Excel/PDF export, data conversion, formatting, timers, email parsing and SMTP sending |
| Testing Guide | docs/TESTING.md |
Running tests, markers, coverage |
| Security | docs/SECURITY.md |
Pre-commit hooks, credential scanning |
| Changelog | CHANGELOG.md |
Per-release breaking changes, deploy ordering, additions and fixes |
| Improvement Backlog | docs/IMPROVEMENT_BACKLOG.md |
Proposed and deferred library improvements |
Architecture
Engine (singleton — survives Lambda warm starts)
├── ConnectionPool (thread-safe, configurable min/max)
└── Transaction (one per request, borrows from pool)
├── Table (CRUD, batch ops, schema management)
│ ├── Row (dict-like, lazy-cache, write-through, batch_update())
│ └── Result (streaming cursor iteration, transforms)
├── View (create, grant, ensure)
└── Sequence (create, next, current, configure)
Transactions auto-commit on success, auto-rollback on exception. Connections are returned to the pool (or discarded on error). The Engine persists across Lambda invocations, so the pool stays warm.
Multi-Database Support
| Database | Driver | Status |
|---|---|---|
| PostgreSQL | psycopg[binary]>=3.2.0 |
Primary, fully tested |
| MySQL | mysql-connector-python |
Supported |
| SQLite | sqlite3 (stdlib) |
Supported |
| SQL Server | python-tds |
Supported |
# PostgreSQL
from velocity.db.servers.postgres import initialize
engine = initialize()
# MySQL
from velocity.db.servers.mysql import initialize
engine = initialize()
# SQLite
from velocity.db.servers.sqlite import initialize
engine = initialize(config={"database": "myapp.db"})
# SQL Server
from velocity.db.servers.sqlserver import initialize
engine = initialize()
Project Structure
velocity-python/
├── src/velocity/
│ ├── cache.py # Process-level read cache (cache_ttl / memo)
│ ├── logging.py # Logging setup (JSON in Lambda, text elsewhere)
│ ├── db/
│ │ ├── core/
│ │ │ ├── engine.py # Engine, ConnectionPool, @engine.transaction
│ │ │ ├── lazy_engine.py # LazyEngine (build on first use)
│ │ │ ├── transaction.py # Transaction, query timing, caching, on_commit
│ │ │ ├── table.py # Table CRUD, batch ops, purge, schema
│ │ │ ├── row.py # Row (dict-like, write-through, batch_update())
│ │ │ ├── result.py # Result (cursor wrapper, transforms)
│ │ │ ├── column.py # Column helpers
│ │ │ ├── database.py # Database-level operations
│ │ │ ├── jsonproxy.py # Live list/dict values for JSON columns
│ │ │ ├── async_support.py # Async versions of core classes
│ │ │ ├── view.py # View management
│ │ │ ├── sequence.py # Sequence management
│ │ │ └── decorators.py # @create_missing, @return_default, retries
│ │ ├── servers/
│ │ │ ├── postgres/ # PostgreSQL dialect + initializer (primary)
│ │ │ ├── mysql/ # MySQL dialect
│ │ │ ├── sqlite/ # SQLite dialect
│ │ │ ├── sqlserver/ # SQL Server dialect
│ │ │ └── tablehelper.py # Where/column/pointer-join compiler
│ │ ├── fragments.py # Literal / @@ token handling
│ │ ├── maintenance.py # DatabaseMaintenance (clone, snapshot, prune)
│ │ ├── migrations.py # `velocity` CLI: migration runner
│ │ ├── tunnel.py # DB_TUNNEL support
│ │ └── exceptions.py # Db* exception hierarchy
│ ├── aws/
│ │ ├── handlers/ # LambdaHandler, SqsHandler, context, mixins
│ │ │ └── mixins/ # DataService, client-input guard, jobs, sessions, web
│ │ ├── capabilities/ # Per-site capability registry and provisioning
│ │ ├── assets/ # Asset store: indexing, references, usage
│ │ ├── deploy/ # Platform-neutral deployment engine
│ │ ├── ssm_config.py # SSM-backed config (project, then /Global)
│ │ ├── s3.py # Presigned URLs, configured buckets
│ │ ├── failures.py # Failure events (SNS)
│ │ ├── feature_flags.py # sys_feature_flags cache + mirror
│ │ ├── mirror.py # Cross-database table mirroring
│ │ ├── job_lifecycle.py # Job status tracking
│ │ ├── job_results.py # Job result stores
│ │ ├── dirty_pipeline.py # sys_dirty / on_dirty pipeline
│ │ ├── ops.py # Operations dashboard data
│ │ ├── email.py / sms.py # SES email, SMS
│ │ └── amplify.py, amplify_build.py, blobs.py, facets.py
│ ├── nosql/ # NoSQL store contract + adapters
│ ├── payment/
│ │ ├── base_adapter.py # Abstract payment interface
│ │ ├── stripe_adapter.py # Stripe
│ │ ├── braintree_adapter.py # Braintree
│ │ ├── authorizenet_adapter.py # Authorize.Net (CIM)
│ │ ├── *_mirror.py # Processor mirror tables
│ │ └── money.py, charge_rules.py, redact.py
│ └── misc/ # conv (iconv/oconv), export, format, mail, pdf, timer, ...
├── tests/ # Unit tests (make test-unit)
├── docs/ # Detailed documentation
└── pyproject.toml
Development
# Install with dev dependencies
pip install -e ".[dev,test,postgres]"
# Run the unit suite (no database needed)
make test-unit
# Or directly
pytest
# Run with coverage
pytest --cov=velocity --cov-report=html
# Run specific test file
pytest tests/test_connection_pool.py -v
License
MIT
1 maintainer
Metadata
1 maintainer
Release files for velocity-python 0.2.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| velocity_python-0.2.2.tar.gz | 953.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| velocity_python-0.2.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.7 MB
Release files / velocity_python-0.2.2.tar.gz
| Download URL | velocity_python-0.2.2.tar.gz |
|---|---|
| Size | 953.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2c8d3cef698d724538656164537dcaf4743d3fd874218bb13c846588f3a27222
|
|
BLAKE2b-256 checksum How to use checksums |
ea973d93130281f6653557ca6bb2b714f4f3c70e575587705c79a26bd5a4cb70
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.11.15
|
Release files / velocity_python-0.2.2-py3-none-any.whl
| Download URL | velocity_python-0.2.2-py3-none-any.whl |
|---|---|
| Size | 702.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2396e0e3c8214fef89558e732f39632a4eef83482e86f79d3a734352f31cc5b2
|
|
BLAKE2b-256 checksum How to use checksums |
295ebd642bf75274d0093be736e4d324ac655fe21bd343f6bf737b1aa14e9e45
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.11.15
|
