Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md by including email #613

Merged
merged 7 commits into from
Oct 4, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@ Closes #2
-
-

If you have questions, please send an email to [Sendgrid](mailto:[email protected]), or file a Github Issue in this repository.
If you have questions, please send an email to [SendGrid](mailto:[email protected]), or file a GitHub Issue in this repository.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ A software bug is a demonstrable issue in the code base. In order for us to diag

Before you decide to create a new issue, please try the following:

1. Check the Github issues tab if the identified issue has already been reported, if so, please add a +1 to the existing post.
1. Check the GitHub issues tab if the identified issue has already been reported, if so, please add a +1 to the existing post.
2. Update to the latest version of this code and check if issue has already been fixed
3. Copy and fill in the Bug Report Template we have provided below

Expand Down Expand Up @@ -242,4 +242,4 @@ If you have any additional questions, please feel free to [email](mailto:dx@send
<a name="code-reviews"></a>
## Code Reviews
If you can, please look at open PRs and review them. Give feedback and help us merge these PRs much faster! If you don't know how, Github has some great [information on how to review a Pull Request](https://help.github.com/articles/about-pull-request-reviews/).
If you can, please look at open PRs and review them. Give feedback and help us merge these PRs much faster! If you don't know how, GitHub has some great [information on how to review a Pull Request](https://help.github.com/articles/about-pull-request-reviews/).
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,10 +57,10 @@ echo "export SENDGRID_API_KEY='YOUR_API_KEY'" > sendgrid.env
echo "sendgrid.env" >> .gitignore
source ./sendgrid.env
```
Sendgrid also supports local environment file `.env`. Copy or rename `.env_sample` into `.env` and update [SENDGRID_API_KEY](https://app.sendgrid.com/settings/api_keys) with your key.
SendGrid also supports local environment file `.env`. Copy or rename `.env_sample` into `.env` and update [SENDGRID_API_KEY](https://app.sendgrid.com/settings/api_keys) with your key.

### Windows
Temporarily set the environment variable(accesible only during the current cli session):
### Windows
Temporarily set the environment variable(accessible only during the current cli session):
```bash
set SENDGRID_API_KEY=YOUR_API_KEY
```
Expand Down Expand Up @@ -105,7 +105,7 @@ print(response.body)
print(response.headers)
```

The `Mail` constructor creates a [personalization object](https://sendgrid.com/docs/Classroom/Send/v3_Mail_Send/personalizations.html) for you. [Here](https://github.com/sendgrid/sendgrid-python/blob/master/examples/helpers/mail/mail_example.py#L16) is an example of how to add it.
The `Mail` constructor creates a [personalization object](https://sendgrid.com/docs/Classroom/Send/v3_Mail_Send/personalizations.html) for you. [Here](https://github.com/sendgrid/sendgrid-python/blob/master/examples/helpers/mail_example.py#L16) is an example of how to add it.

### Without Mail Helper Class

Expand Down Expand Up @@ -212,9 +212,9 @@ Quick links:

- [Feature Request](https://github.com/sendgrid/sendgrid-python/blob/master/CONTRIBUTING.md#feature-request)
- [Bug Reports](https://github.com/sendgrid/sendgrid-python/blob/master/CONTRIBUTING.md#submit-a-bug-report)
- [Sign the CLA to Create a Pull Request](https://cla.sendgrid.com/sendgrid/sendgrid-python)
- [Improvements to the Codebase](https://github.com/sendgrid/sendgrid-python/blob/master/CONTRIBUTING.md#improvements-to-the-codebase)
- [Review Pull Requests](https://github.com/sendgrid/sendgrid-python/blob/master/CONTRIBUTING.md#code-reviews)
- [Sign the CLA to Create a Pull Request](https://cla.sendgrid.com/sendgrid/sendgrid-python)

<a name="troubleshooting"></a>
# Troubleshooting
Expand All @@ -224,7 +224,9 @@ Please see our [troubleshooting guide](https://github.com/sendgrid/sendgrid-pyth
<a name="about"></a>
# About

sendgrid-python is guided and supported by the SendGrid [Developer Experience Team](mailto:[email protected]).
sendgrid-python is guided and supported by the SendGrid Developer Experience Team.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a space between these two lines. Thanks!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed spacing and alphabetical order


Email the Developer Experience Team [here](mailto:[email protected]) in case of any queries.

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

Expand Down
2 changes: 1 addition & 1 deletion sendgrid/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
This library allows you to quickly and easily use the SendGrid Web API v3 via
Python.
For more information on this library, see the README on Github.
For more information on this library, see the README on GitHub.
https://github.com/sendgrid/sendgrid-python
For more information on the SendGrid v3 API, see the v3 docs:
http://sendgrid.com/docs/API_Reference/api_v3.html
Expand Down
2 changes: 1 addition & 1 deletion sendgrid/helpers/endpoints/ip/unassigned.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ def unassigned(data, as_json=False):
and the usernames assigned to an IP
unassigned returns a listing of the IP addresses that are allocated
but have 0 usera assigned
but have 0 users assigned
data (response.body from sg.client.ips.get())
Expand Down
2 changes: 1 addition & 1 deletion sendgrid/sendgrid.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
This library allows you to quickly and easily use the SendGrid Web API v3 via
Python.
For more information on this library, see the README on Github.
For more information on this library, see the README on GitHub.
https://github.com/sendgrid/sendgrid-python
For more information on the SendGrid v3 API, see the v3 docs:
http://sendgrid.com/docs/API_Reference/api_v3.html
Expand Down
10 changes: 5 additions & 5 deletions use_cases/aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Python 2.6, 2.7, 3.4, or 3.5 are supported by the sendgrid Python library, howev

Before starting this tutorial, you will need to have access to an AWS account in which you are allowed to provision resources. This tutorial also assumes you've already created a SendGrid account with free-tier access. Finally, it is highly recommended you utilize [virtualenv](https://virtualenv.pypa.io/en/stable/).

*DISCLAIMER*: Any resources provisioned here may result in charges being incurred to your account. Sendgrid is in no way responsible for any billing charges.
*DISCLAIMER*: Any resources provisioned here may result in charges being incurred to your account. SendGrid is in no way responsible for any billing charges.


## Getting Started
Expand All @@ -36,15 +36,15 @@ On the next menu, you have the option to choose what programming language you'll

Follow the steps on the next screen. Choose a name for your API key, such as "hello-email". Follow the remaining steps to create an environment variable, install the sendgrid module, and copy the test code. Once that is complete, check the "I've integrated the code above" box, and click the "Next: Verify Integration" button.

Assuming all the steps were completed correctly, you should be greeted with a success message. If not, go back and verify that everything is correct, including your API key environment varible, and Python code.
Assuming all the steps were completed correctly, you should be greeted with a success message. If not, go back and verify that everything is correct, including your API key environment variable, and Python code.

## Deploy hello-world app using CodeStar

For the rest of the tutorial, we'll be working out of the git repository we cloned from AWS earlier:
For the rest of the tutorial, we'll be working out of the Git repository we cloned from AWS earlier:
```
$ cd hello-email
```
note: this assumes you cloned the git repo inside your current directory. My directory is:
note: this assumes you cloned the Git repo inside your current directory. My directory is:

```
~/projects/hello-email
Expand Down Expand Up @@ -139,7 +139,7 @@ def handler(event, context):
'headers': {'Content-Type': 'application/json'}}
```

Note that for the most part, we've simply copied the intial code from the API verification with SendGrid. Some slight modifications were needed to allow it to run as a lambda function, and for the output to be passed cleanly from the API endpoint.
Note that for the most part, we've simply copied the initial code from the API verification with SendGrid. Some slight modifications were needed to allow it to run as a lambda function, and for the output to be passed cleanly from the API endpoint.

Change the `[email protected]` emails appropriately so that you may receive the test email.

Expand Down
4 changes: 2 additions & 2 deletions use_cases/slack_event_api_integration.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Integrate with Slack Events API

It's fairly straightforward to integrate Sendgrid with Slack, to allow emails to be triggered by events happening on Slack.
It's fairly straightforward to integrate SendGrid with Slack, to allow emails to be triggered by events happening on Slack.

For this, we make use of the [Official Slack Events API](https://github.com/slackapi/python-slack-events-api), which can be installed using pip.

To allow our application to get notifications of slack events, we first create a Slack App with Event Subscriptions as described [here](https://github.com/slackapi/python-slack-events-api#--development-workflow)

Then, we set `SENDGRID_API_KEY` _(which you can create on the Sendgrid dashboard)_ and `SLACK_VERIFICATION_TOKEN` _(which you can get in the App Credentials section of the Slack App)_ as environment variables.
Then, we set `SENDGRID_API_KEY` _(which you can create on the SendGrid dashboard)_ and `SLACK_VERIFICATION_TOKEN` _(which you can get in the App Credentials section of the Slack App)_ as environment variables.

Once this is done, we can subscribe to [events on Slack](https://api.slack.com/events) and trigger emails when an event occurs. In the example below, we trigger an email to `[email protected]` whenever someone posts a message on Slack that has the word "_help_" in it.

Expand Down
2 changes: 1 addition & 1 deletion use_cases/transational_templates.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
### Transactional Templates

Sendgrid transactional templates let you leverage power of [handlebars](https://handlebarsjs.com/)
SendGrid transactional templates let you leverage power of [handlebars](https://handlebarsjs.com/)
syntax to easily manage complex dynamic content in transactional emails.

For this example, we assume you have created a [transactional template](https://sendgrid.com/docs/User_Guide/Transactional_Templates/create_and_edit_transactional_templates.html). Following is the template content we used for testing.
Expand Down