sendgrid-cli

A very simple SendGrid CLI written in Python with only basic functionalities (at this moment).

The official sendgrid-cli hasn't been updated in years and I couldn't get it to work,
so I wrote this with only the features I need.

If you need more features, feel free to contribute by submitting pull requests.

• sendgrid-cli
  • Installation
    • pipx
    • pip
  • Usage
    • On the command line
    • On GitHub Actions
  • Develop

Installation

pipx

This is the recommended installation method.

$ pipx install sendgrid-cli

pip

$ pip install sendgrid-cli

Usage

On the command line

usage: sendgrid [-h] [-V] [-t str [str ...]] [-f str] [-n str] [-s str]

sendgrid CLI

options:
  -h, --help            show this help message and exit
  -V, --version         show program's version number and exit
  -t str [str ...], --to-emails str [str ...]
                        To emails (default: None)
  -f str, --from-email str
                        From email EMAIL (default: None)
  -n str, --from-name str
                        From name NAME (default: None)
  -s str, --subject str
                        Subject (default: None)
  -H, --html            send as html instead of plain text (default: False)

Email body (HTML) is read from stdin, supply your API key with SENDGRID_API_KEY environment variable

On GitHub Actions

Below is a working job configuration

  send-mail:
    runs-on: ubuntu-latest
    steps:
      - name: setup python 3.10
        uses: actions/setup-python@v4
        with:
          python-version: '3.10'
      - name: install CLI tools
        run: pipx install sendgrid-cli
      - name: Send email
        env:
          SENDGRID_API_KEY: ${{ secrets.SENDGRID_API_KEY }}
        run: |
          cat email-body.html | sendgrid -f 'from@example.com' -n 'from-name' -t 'to@example.com' -s 'sendgrid-cli test' --html

Develop

$ git clone https://github.com/tddschn/sendgrid-cli.git
$ cd 
$ poetry install