Skip to content

Latest commit

 

History

History
executable file
·
224 lines (158 loc) · 5.2 KB

notifications.rst

File metadata and controls

executable file
·
224 lines (158 loc) · 5.2 KB
Raw

Notifications

Slack

Overview

The Slack module leverages the Slack API and provides way to easily send notifications through Slack. It is recommended that you reference the Slack API documentation for additional details and information.

Note

API Tokens

  • Slack API Tokens are required to use this module. To obtain an API Token, create a Slack App associated with the desired Slack workspace. Once you create the app, navigate to 'OAuth & Permissions' and add the following OAuth scopes:

    channels:read, users:read, chat:write, and files:write

    You can now install the Slack App, which will produce an API Token. Note that you can change the scopes any time, but you must reinstall the app each time (your API Token will stay the same).

  • Slack has rate limits on all its endpoints.

.. toctree::
        :maxdepth: 1

QuickStart

To call the Slack class you can either store the API Token as an environment variable SLACK_API_TOKEN or pass it in as an argument.

from parsons import Slack

slack = Slack() # Initiate class via environment variable api token

slack = Slack(api_key='my-api-tkn') # Pass api token directly

You can then send messages:

from parsons import Slack

slack = Slack()

# send a simple messsage
slack.message_channel("my_channel", "Hello from python script")

# share a file
slack.upload_file(["channel_1", "channel_2"], "my_slack_file.txt")

API

.. autoclass:: parsons.Slack
   :inherited-members:

Gmail

Overview

The Gmail module leverages the Gmail API and provides an way to easily send notifications through email. It is recommended that you reference the Gmail API documentation for additional details and information.

Note

Credentials and token
  • Credentials are required to use the class
  • You will need to pass in the path to the credentials and to where a generated token will be saved. Typically you’ll get the credentials from the Google Developer Console (look for the “Gmail API”).

Note

6MB Attachment Size Limit
  • Currently there is a limit of 6MB when sending attachments.
.. toctree::
        :maxdepth: 1

QuickStart

To call the Gmail class you will need to pass in the path to a credentials.json and the path to tokens.json.

from parsons import Gmail

gmail = Gmail(
   creds_path="~/secret_location/credentials.json",
   token_path="~/secret_location/token.json")

The easiest way to send a message:

gmail.send_email(
  "[email protected]",
  "[email protected]",
  "The Subject",
  "This is the text body of the email")

The current version also supports sending html emails and emails with attachments.

gmail.send_email(
  "[email protected]",
  "[email protected]",
  "An html email with attachments",
  "This is the text body of the email",
  html="<p>This is the html part of the email</p>",
  files=['file1.txt', 'file2.txt'])

Additionally, you can create a raw email messages and send it. See below for more details.

API

.. autoclass:: parsons.Gmail
  :inherited-members:

:inherited-members:

SMTP

Overview

The SMTP module enables the sending of email through a generic SMTP server. If you have an email server other than Gmail this is likely the best way to send emails with Parsons.

Note

Credentials
  • Credentials are required to use the class. You'll need to provide a valid username and password for the SMTP server you are using.
.. toctree::
        :maxdepth: 1

QuickStart

To initialize the SMTP class you will need to tell it how to connect to the SMTP server:

from parsons import SMTP

smtp = SMTP(
    host="fake.host.com",
    port=9999,
    username="my_username",
    password="dont_use_this_password"
)

Note

Environment Variables
  • Instead of passing in values to initialize an instance of the SMTP class, you can set environment variables to hold the values. The names of the environment variables are the names of the arguments capitalized and prefixed with SMTP_. For example, SMTP_HOST or SMTP_PASSWORD. If both an environment variable and an initialization argument are present, the argument will take precedence.

The easiest way to send a message:

smtp.send_email(
    "[email protected]",
    "[email protected]",
    "The Subject",
    "This is the text body of the email"
)

The current version also supports sending html emails and emails with attachments.

smtp.send_email(
    "[email protected]",
    "[email protected]",
    "An html email with attachments",
    "This is the text body of the email",
    html="<p>This is the html part of the email</p>",
    files=['file1.txt', 'file2.txt']
)

API

.. autoclass:: parsons.SMTP
  :inherited-members: