Lockally for Flask
Official Lockally extension for Flask. Send transactional
email from any view with a small, idiomatic Lockally(app) extension.
Install
pip install lockally-flask
Configure
from flask import Flask
from lockally_flask import Lockally
app = Flask(__name__)
app.config["LOCKALLY_API_KEY"] = "lk_live_xxx" # lk_test_xxx runs in sandbox
# app.config["LOCKALLY_BASE_URL"] = "https://api.lockally.com" # optional override
lockally = Lockally(app)
The application-factory pattern is supported too:
lockally = Lockally()
def create_app():
app = Flask(__name__)
app.config["LOCKALLY_API_KEY"] = "lk_live_xxx"
lockally.init_app(app)
return app
Send
from lockally_flask import send_email
@app.post("/signup")
def signup():
send_email(
from_="alerts@yourdomain.com",
to="user@example.com",
subject="Welcome",
text="Thanks for signing up.",
html="<b>Thanks for signing up.</b>",
reply_to="support@yourdomain.com",
attachments=[("welcome.pdf", pdf_bytes, "application/pdf")],
)
return "", 202
send_email uses the client registered on the current app, so blueprints can call it
without holding a reference. to/cc/bcc/reply_to accept a single address or a
list; attachments is a list of (filename, content, content_type) (content is bytes
or str).
Mapping notes
- Reply-To is sent as a header (Lockally has no
reply_tofield). - Attachments are base64-encoded as
{filename, content_type, content_base64}. - One
Idempotency-Keyis generated per send (24 h dedupe window).
License
MIT © Lockally
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file lockally_flask-0.1.0.tar.gz.
File metadata
- Download URL: lockally_flask-0.1.0.tar.gz
- Upload date:
- Size: 5.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
96cbf0147f170f20d51289a035daa98e12ac5935dc128e64fb457fa458a24a59
|
|
| MD5 |
625e5262313247a40f5daa03ae6fa11a
|
|
| BLAKE2b-256 |
b7542b832e1d0561e4fb8358c23b27219f41cb586fb34b34c0e422bfcf429262
|
Provenance
The following attestation bundles were made for lockally_flask-0.1.0.tar.gz:
Publisher:
publish.yml on LockallyInc/lockally-flask
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
lockally_flask-0.1.0.tar.gz -
Subject digest:
96cbf0147f170f20d51289a035daa98e12ac5935dc128e64fb457fa458a24a59 - Sigstore transparency entry: 2359380621
- Sigstore integration time:
-
Permalink:
LockallyInc/lockally-flask@fa630b328fbb1519d267021eb889026fe3e84d8a -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/LockallyInc
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@fa630b328fbb1519d267021eb889026fe3e84d8a -
Trigger Event:
push
-
Statement type:
File details
Details for the file lockally_flask-0.1.0-py3-none-any.whl.
File metadata
- Download URL: lockally_flask-0.1.0-py3-none-any.whl
- Upload date:
- Size: 5.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
636852e92f2f0168ceda8af3e495308fa21f01eb72ee26f3f33425fe4341333c
|
|
| MD5 |
3654dd830ecad6050981f5bba506ab91
|
|
| BLAKE2b-256 |
d7280a1de15d3e2d162c3cffe2cd613a13468a7c36bc1895fed38f334f17a2ba
|
Provenance
The following attestation bundles were made for lockally_flask-0.1.0-py3-none-any.whl:
Publisher:
publish.yml on LockallyInc/lockally-flask
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
lockally_flask-0.1.0-py3-none-any.whl -
Subject digest:
636852e92f2f0168ceda8af3e495308fa21f01eb72ee26f3f33425fe4341333c - Sigstore transparency entry: 2359380810
- Sigstore integration time:
-
Permalink:
LockallyInc/lockally-flask@fa630b328fbb1519d267021eb889026fe3e84d8a -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/LockallyInc
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@fa630b328fbb1519d267021eb889026fe3e84d8a -
Trigger Event:
push
-
Statement type:
