Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Latest commit

 

History

History
History
 
 

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 

README.md

Outline

Use Docker to easily try out or contribute to the sendgrid-python library.

This Docker image contains:

  • Python 3.6
  • A running instance of Stoplight.io's Prism, which lets you try out the SendGrid API without actually sending email
  • A mirrored copy of sendgrid-php so that you may develop locally and then run the tests within the Docker container.

Table of Contents

Quick Start

  1. Clone the sendgrid-python repo
  • git clone https://github.com/sendgrid/sendgrid-python.git
  • cd sendgrid-python
  • python setup.py install
  1. Install Docker
  2. Setup local environment variable SENDGRID_API_KEY
  3. Build Docker image, run Docker container, login to the Docker container
  • docker image build --tag="sendgrid/python3.6" ./docker-test
  • docker run -itd --name="sendgrid_python3.6" -v $(pwd):/root/sendgrid-python sendgrid/python3.6 /bin/bash
  1. Run the tests within the Docker container
  • sudo docker exec -it sendgrid_python3.6 /bin/bash -c 'cd sendgrid-python; python3.6 -m unittest discover -v; exec "${SHELL:-sh}"'

Now you can continue development locally, and run python3.6 -m unittest discover -v inside of the container to test.

To clean up the container: docker stop sendgrid_python3.6 && docker rm sendgrid_python3.6.

Happy Hacking!

For Testing the Library (Kick the Tires)

  • After step 5 in the QuickStart, within the Docker container:
    • cd ../
    • python sendmail.py

For Contributors

  • Develop per usual locally, but before pushing up to GitHub, you can run the tests locally in the Docker container per step 5 of the quickstart.
  • To run all the tests: python3.6 -m unittest discover -v
  • To run an individual test: python3.6 -m unittest [Filename].[Class].[TestName]
Morty Proxy This is a proxified and sanitized view of the page, visit original site.