<commit_before>You can use Docker to easily try out or test sendgrid-python.

<a name="Quickstart"></a>
# Quickstart

1. Install Docker on your machine.
2. Run `docker run -it sendgrid/sendgrid-python`.

<a name="Info"></a>
# Info

This Docker image contains
 - `sendgrid-python` and `python-http-client`
 - Stoplight's Prism, which lets you try out the API without actually sending email
 - A complete setup for testing the repository or your own fork

Run it in interactive mode with `-it`.

You can mount repositories in the `/mnt/sendgrid-python` and `/mnt/python-http-client` directories to use them instead of the default SendGrid libraries. Read on for more info.

<a name="Options"></a>
# Options

## Using an old version

The easiest way to use an old version is to use an old tag.

    $ docker run -it sendgrid/sendgrid-python:v3.6.1

Tags from before this Docker image was created might not exist yet. You may [manually download](#Versions) old versions in order to use them.

<a name="Versions"></a>
## Specifying a version

To use a different version of sendgrid-python or python-http-client - for instance, to replicate your production setup - mount it with the `-v <host_dir>:<container_dir>` option. When you put either repository under `/mnt`, the container will automatically detect it and make the proper symlinks. You can edit these files from the host machine while the container is running.

For instance, to install sendgrid-python 3.6.1 and use the current python-http-client:

    $ git clone https://github.com/sendgrid/sendgrid-python.git --branch v3.6.1
    $ realpath sendgrid-python
    /path/to/sendgrid-python
    $ docker run -it -v /path/to/sendgrid-python:/mnt/sendgrid-python sendgrid/sendgrid-python

To install sendgrid-python v3.6.1 and use an older version of python-http-client:

    $ git clone https://github.com/sendgrid/sendgrid-python.git --branch v3.6.1
    $ realpath sendgrid-python
    /path/to/sendgrid-python
    $ git clone https://github.com/sendgrid/python-http-client.git --branch v1.2.4
    $ realpath python-http-client
    /path/to/python-http-client
    $ docker run -it -v /path/to/sendgrid-python:/mnt/sendgrid-python \
                     -v /path/to/python-http-client:/mnt/python-http-client \
                     sendgrid/sendgrid-python

## Specifying your own fork:

    $ git clone https://github.com/you/cool-sendgrid-python.git
    $ realpath cool-sendgrid-python
    /path/to/cool-sendgrid-python
    $ docker run -it -v /path/to/cool-sendgrid-python:/mnt/sendgrid-python sendgrid/sendgrid-python

Note that the paths you specify in `-v` must be absolute.

<a name="Testing"></a>
# Testing
Testing is easy!  Run the container, `cd sendgrid`, and run `tox`.

<a name="about"></a>
# About

sendgrid-python is guided and supported by the SendGrid [Developer Experience Team](mailto:<EMAIL>).

sendgrid-python is maintained and funded by SendGrid, Inc. The names and logos for sendgrid-python are trademarks of SendGrid, Inc.

![SendGrid Logo](https://uiux.s3.amazonaws.com/2016-logos/email-logo%402x.png)
<commit_msg>Add syntax highlighting in Readme<commit_after>You can use Docker to easily try out or test sendgrid-python.

<a name="Quickstart"></a>
# Quickstart

1. Install Docker on your machine.
2. Run `docker run -it sendgrid/sendgrid-python`.

<a name="Info"></a>
# Info

This Docker image contains
 - `sendgrid-python` and `python-http-client`
 - Stoplight's Prism, which lets you try out the API without actually sending email
 - A complete setup for testing the repository or your own fork

Run it in interactive mode with `-it`.

You can mount repositories in the `/mnt/sendgrid-python` and `/mnt/python-http-client` directories to use them instead of the default SendGrid libraries. Read on for more info.

<a name="Options"></a>
# Options

## Using an old version

The easiest way to use an old version is to use an old tag.

```sh-session
$ docker run -it sendgrid/sendgrid-python:v3.6.1
```

Tags from before this Docker image was created might not exist yet. You may [manually download](#Versions) old versions in order to use them.

<a name="Versions"></a>
## Specifying a version

To use a different version of sendgrid-python or python-http-client - for instance, to replicate your production setup - mount it with the `-v <host_dir>:<container_dir>` option. When you put either repository under `/mnt`, the container will automatically detect it and make the proper symlinks. You can edit these files from the host machine while the container is running.

For instance, to install sendgrid-python 3.6.1 and use the current python-http-client:

```sh-session
$ git clone https://github.com/sendgrid/sendgrid-python.git --branch v3.6.1
$ realpath sendgrid-python
/path/to/sendgrid-python
$ docker run -it -v /path/to/sendgrid-python:/mnt/sendgrid-python sendgrid/sendgrid-python
```

To install sendgrid-python v3.6.1 and use an older version of python-http-client:

```sh-session
$ git clone https://github.com/sendgrid/sendgrid-python.git --branch v3.6.1
$ realpath sendgrid-python
/path/to/sendgrid-python
$ git clone https://github.com/sendgrid/python-http-client.git --branch v1.2.4
$ realpath python-http-client
/path/to/python-http-client
$ docker run -it -v /path/to/sendgrid-python:/mnt/sendgrid-python \
>                -v /path/to/python-http-client:/mnt/python-http-client \
>                sendgrid/sendgrid-python
```

## Specifying your own fork:

```sh-session
$ git clone https://github.com/you/cool-sendgrid-python.git
$ realpath cool-sendgrid-python
/path/to/cool-sendgrid-python
$ docker run -it -v /path/to/cool-sendgrid-python:/mnt/sendgrid-python sendgrid/sendgrid-python
```

Note that the paths you specify in `-v` must be absolute.

<a name="Testing"></a>
# Testing
Testing is easy!  Run the container, `cd sendgrid`, and run `tox`.

<a name="about"></a>
# About

sendgrid-python is guided and supported by the SendGrid [Developer Experience Team](mailto:<EMAIL>).

sendgrid-python is maintained and funded by SendGrid, Inc. The names and logos for sendgrid-python are trademarks of SendGrid, Inc.

![SendGrid Logo](https://uiux.s3.amazonaws.com/2016-logos/email-logo%402x.png)

{'fraction_non_alphanumeric': 0.11035818005808325, 'fraction_numerical': 0.0090351726363343, 'mean_word_length': 3.6997725549658833, 'pattern_counts': {'":': 0, '<': 33, '<?xml version=': 0, '>': 35, 'https://': 10, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 4, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3343840', 'n_tokens_mistral': 1963, 'n_tokens_neox': 1873, 'n_words': 678}