No project description provided
Project description
ODK Mailer
A simple CLI to send Mails for ODK. Built with Typer and packaged with Poetry.
Requirements
- Python 3
- PIP
Setup
pip install odk-mailer
Usage
# Create a new mail job with a unique ID
odk-mailer create
# Run the job by ID
odk-mailer run <job-id>
# Show all jobs
odk-mailer list
# Run all jobs that are ready to be sent
odk-mailer eval
CLI Design
Create
Features > commands
create a mail job
- Read a recipients CSV list, validate input
- Define field from available headers to be used for email sending, validate email addresses
- Read message content from stdin
- Support data templating with format
- Read message content from file
- Add reminders for a mail task, using ODK API, http-lib
- Send mail manually or schedule for the future; smtp, python-crontab
list mail jobs
- Show available mail tasks (that are stored in the local db)
delete mail jobs
- delete mail job by id
check connection
- give instant feedback about connectivity to SMTP and API endpoints
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
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.1.0.tar.gz
(12.7 kB
view hashes)
Built Distribution
odk_mailer-0.1.0-py3-none-any.whl
(16.3 kB
view hashes)
Close
Hashes for odk_mailer-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | deff8de8e40e4f68bfb0e65781147e64085730f156cc694d9f568582fbe4114c |
|
MD5 | f32b82e4ad9f4d26da36232e1c4bb877 |
|
BLAKE2b-256 | 63fb104ab51ba893d3fbed9d47de5b5bcf86e708f9116b24b7bd24d616d9d7cf |