easybrevo 0.1.2

Use Brevo API with Python (the easy way)

easybrevo

Use Brevo API with Python (the easy way).

Installation

pip install easybrevo

Usage

First of all, you have to instantiate an API client:

from easybrevo import ApiClient

client = ApiClient()

ApiClient() admits one argument api_key → Brevo API key (Generate from here).

If api_key is not provided, its value will be collected from BREVO_API_KEY within a .env file or as an environment variable. Otherwise an error will raise.

Sending an email

The quickest way to send an email is the following:

client.send_email(
    to="[e-mail]",
    subject="This is the subject",
    content="This is the content"
)

Sender

send_mail() admits arguments sender_email and sender_name in order to set sender information when sending the email.

If sender_email is not provided, its value will be collected from BREVO_SENDER_EMAIL within a .env file or as an environment variable. Otherwise a dumb default value is used.

If sender_name is not provided, its value will be collected from BREVO_SENDER_NAME within a .env file or as an environment variable. Otherwise a dumb default value is used.

Content type

By default, the content of the email is intepreted as plain text, but this behaviour can be changed with the argument content_type:

• content_type='txt' → Text (default)
• content_type='md' → Markdown
• content_type='html' → HTML

Attachments

You can attach files to the email using attachments argument.

It can contain a single file (path) or a list of file paths to be included as attachments in the email.