A simple CLI for sending form related mails in the context of Open Data Kit (ODK)
Project description
ODK Mailer
A simple CLI to send Mails for ODK. Built with Typer and packaged with Poetry.
Requirements
- Python 3
- PIP
Setup
Install the cli via pip
pip install odk-mailer
Configuration example
Config location: ~/.env
:
SMTP_HOST=smtp.freesmtpservers.com
SMTP_PORT=25
SMTP_USER=
SMTP_PASS=
ODK_HOST=https://your.odk-central.host.tld
Usage
Create and run a new mail job
# Create a new mail job with a unique ID
odk-mailer jobs create
# Run the job by ID
odk-mailer jobs run <job-id>
List mail jobs and evaluate them
# Show all jobs
odk-mailer jobs list
# Run all jobs that are ready to be sent
odk-mailer jobs evaluate
Development
Building a Package - Guide: https://typer.tiangolo.com/tutorial/package/#create-your-app
Requirements
- Python 3.10
- Poetry 1.7
# clone the repo and cd into
poetry shell
poetry install
# Run it with
poetry run odk-mailer
Push to PyPi
poetry build
poetry publish
# requires credentials to be setup: poetry config pypi-token.pypi <my-token>
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
odk_mailer-0.6.6.tar.gz
(16.1 kB
view hashes)
Built Distribution
odk_mailer-0.6.6-py3-none-any.whl
(21.4 kB
view hashes)
Close
Hashes for odk_mailer-0.6.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b730fb5f6f82d100ba19d99c90cc0cabf9b85ad643b2f96483ae7bac0e2ead80 |
|
MD5 | 6d43b9949c89c0093aec55f989fa5530 |
|
BLAKE2b-256 | c1834f6d297739c2f1857b354efed31d037e7a7a8e7f55f0c1dcf3bafa91371b |