Skip to main content

Data common code for AWS Simple Email Service by Equinox

Project description

PyPI Version Documentation Status Code Quality Grade Coverage Code of Conduct

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.

Source Distribution

datacoco-email_tools-0.1.4.tar.gz (4.0 kB view details)

Uploaded Source

File details

Details for the file datacoco-email_tools-0.1.4.tar.gz.

File metadata

  • Download URL: datacoco-email_tools-0.1.4.tar.gz
  • Upload date:
  • Size: 4.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.55.1 CPython/3.7.4

File hashes

Hashes for datacoco-email_tools-0.1.4.tar.gz
Algorithm Hash digest
SHA256 0e6ad16b708b163cfb1c09e90b0e8df077e1bd9154083abe3bcf6d14a2f4f5c4
MD5 6f30bacf25a19466d0660bcb26411881
BLAKE2b-256 3e73b824a867a7f31c1b434064ad708ea8faeccfd873a6710238f46bdc062b69

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page