Skip to main content

Data common code for AWS Simple Email Service by Equinox

Project description

Documentation Status https://api.codacy.com/project/badge/Grade/8367602b061d48af9e396cda3231cf59 https://api.codacy.com/project/badge/Coverage/8367602b061d48af9e396cda3231cf59 https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg

datacoco-email_tools provides basic interaction with the Amazon Web Service (AWS) Simple Email Service.

Installation

datacoco-email_tools requires Python 3.6+

python3 -m venv <virtual env name>
source <virtual env name>/bin/activate
pip install datacoco-email-tools

Quickstart

Sending email using one line wrapper

Email.send_mail(
    aws_access_key=AWS_ACCESS_KEY,
    aws_secret_key=AWS_SECRET_KEY,
    aws_sender=SENDER,
    aws_region=AWS_REGION,
    to_addr=RECIPIENTS,
    subject='hello world',
    from_addr='email@github.com',
    text_msg='text message',
    html_msg='html message')

Sending email with attachment using one line wrapper

Email.send_email_with_attachment(
    aws_access_key=AWS_ACCESS_KEY,
    aws_secret_key=AWS_SECRET_KEY,
    aws_sender=SENDER,
    aws_region=AWS_REGION,
    to_addr=RECIPIENTS,
    subject='hello world',
    from_addr='email@github.com',
    filename='helloworld.txt',
    body_msg='email body text')

Development

Getting Started

It is recommended to use the steps below to set up a virtual environment for development:

python3 -m venv <virtual env name>
source <virtual env name>/bin/activate
pip install -r requirements.txt

Testing

pip install -r requirements-dev.txt

To run the testing suite, simply run the command: tox or python -m unittest discover tests

Contributing

Contributions to datacoco_email_tools are welcome!

Please reference guidelines to help with setting up your development environment here.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for datacoco-email-tools, version 0.1.1
Filename, size File type Python version Upload date Hashes
Filename, size datacoco-email_tools-0.1.1.tar.gz (3.9 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page