email-service 1.0.0

Package to integrate different email services with your application in just three lines of code.

Email Service

Python package to quickly integrate different email services with your Application with just 3 lines of code.

---

Send Your email without caring about the backend code.

• GitHub: https://github.com/ramanaditya/email-service
• PyPI: https://pypi.org/project/email-service/

Install it with pip

pip install email-service

Email Integration

Save the API_KEY in the .env file as

SENDGRID_API_KEY=api_key

Import EmailHandler

from email_service.email_handler import EmailHandler

Form the dictionary of data

data = {
    "from_email": "Name WithSpace <[e-mail]>",  # Required
    "subject": "This is the test for the Individual email", # Required
    "reply_to_addresses": "[e-mail]",  
    "html_body": "<h1>Email Template for Individual email</h1>",    # Either of html_body or text_body is required
    "text_body": "Email Template for Individual email",
    "to_for_bulk": [{"name": "Name", "email": "[e-mail]"},], # Required for Bulk Email
    "receipients": {
        "to": [{"name": "name1", "email": "[e-mail]"},],    # Required
        "cc": [{"name": "name2", "email": "[e-mail]"},],   
        "bcc": [{"name": "name3", "email": "[e-mail]"},],
    },
    "attachments": [
        "file_path (pdf)", "calender invite (ics)", "image_path (png/jpg/jpeg)"
    ]
}

Send the email

# For Individual Email
send_email = EmailHandler()

# For Bulk Email
send_email = EmailHandler(email_type="BULK")

Sendgrid Integration

# Send it using sendgrid
response = send_email.sendgrid(data)

Response

status_code:
    202: OK,
    400: Error
message: Error or Success Message

Development

Setup

1. Clone the repository

   git clone https://github.com/ramanaditya/email-service
   

2. Create a virtual environment using virtualenv or venv.

   python -m venv venv 
   source venv/bin/activate
   

3. Upgrade pip

   python -m pip install --upgrade pip
   

4. Install python packages

   python -m pip install -r requirements.txt
   

5. Create new Branch from develop branch

   git checkout -b develop origin/develop
   git checkout -b feature_branch
   

6. Generating distribution archives

   # Downloading latest version of setuptools
   python -m pip install --user --upgrade setuptools wheel
   
   python setup.py sdist bdist_wheel
   

7. Uploading to Test PyPI

   # Upload to Test PyPI https://test.pypi.org/ 
   python -m twine upload --repository testpypi dist/*
   

8. Download the package

   python -m pip install -i https://test.pypi.org/simple/ email-service
   

9. Check against the code

   # Edit the file inside /example to have some valid data
   # export SENDGRID_API_KEY before running the script
   python individual_email.py  # For individual email
   python bulk.py  # For bulk email
   

10. Push the Code

    git add file_which_was_changed
    git commit -m "Commit Message"
    git push -u origin feature_branch
    

Issues

1. Integrating Mailgun
2. Integrating Amazon SES

NOTE: Feel free to open issues. Make sure you follow the Issue Template provided.

Contribution Guidelines

• Write clear meaningful git commit messages (Do read this).

• Make sure your PR's description contains GitHub's special keyword references that automatically close the related issue when the PR is merged. (Check this for more info)

• When you make very very minor changes to a PR of yours (like for example fixing a text in button, minor changes requested by reviewers) make sure you squash your commits afterward so that you don't have an absurd number of commits for a very small fix. (Learn how to squash at here)

• Please follow the PR Template to create the PR.

• Always open PR to develop branch.

• Please read our Code of Conduct.

• Refer this for more.

If you like this repository, support it by star :star2: