Skip to content

Commit 935a4d7

Browse files
committed
fixed changes suggested
1 parent 88ddc58 commit 935a4d7

File tree

6 files changed

+27
-27
lines changed

6 files changed

+27
-27
lines changed

Diff for: CODE_OF_CONDUCT.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# SendGrid Community Code of Conduct
22

3-
The SendGrid open source community is made up of members from around the globe with a diverse set of skills, personalities, and experiences. It is through these differences that our community experiences successes and continued growth. When you're working with members of the community, we encourage you to follow these guidelines, which help steer our interactions and strive to maintain a positive, successful and growing community.
3+
The SendGrid open source community is made up of members from around the globe with a diverse set of skills, personalities, and experiences. It is through these differences that our community experiences successes and continued growth. When you're working with members of the community, we encourage you to follow these guidelines, which help steer our interactions and strive to maintain a positive, successful and growing community.
44

55
### Be Open
66
Members of the community are open to collaboration, whether it's on pull requests, code reviews, approvals, issues or otherwise. We're receptive to constructive comments and criticism, as the experiences and skill sets of all members contribute to the whole of our efforts. We're accepting of all who wish to take part in our activities, fostering an environment where anyone can participate, and everyone can make a difference.
@@ -9,15 +9,15 @@
99
Members of the community are considerate of their peers, which include other contributors and users of SendGrid. We're thoughtful when addressing the efforts of others, keeping in mind that often the labor was completed with the intent of the good of the community. We're attentive in our communications, whether in person or online, and we're tactful when approaching differing views.
1010

1111
### Be Respectful
12-
Members of the community are respectful. We're respectful of others, their positions, their skills, their commitments ,and their efforts. We're respectful of the volunteer efforts that permeate the SendGrid community. We're respectful of the processes outlined in the community, and we work within them. When we disagree, we are courteous in raising our issues. Overall, we're good with each other. We contribute to this community not because we have to, but because we want to. If we remember that, these guidelines will come naturally.
12+
Members of the community are respectful. We're respectful of others, their positions, their skills, their commitments, and their efforts. We're respectful of the volunteer efforts that permeate the SendGrid community. We're respectful of the processes outlined in the community, and we work within them. When we disagree, we are courteous in raising our issues. Overall, we're good with each other. We contribute to this community not because we have to, but because we want to. If we remember that, these guidelines will come naturally.
1313

14-
## Additional Guidance
14+
## Additional Guidance
1515

1616
### Disclose Potential Conflicts of Interest
1717
Community discussions often involve interested parties. We expect participants to be aware when they are conflicted due to employment or other projects they are involved in and disclose those interests to other project members. When in doubt, over-disclose. Perceived conflicts of interest are important to address so that the community’s decisions are credible even when unpopular, difficult or favorable to the interests of one group over another.
1818

1919
### Interpretation
20-
This Code is not exhaustive or complete. It is not a rulebook; it serves to distill our common understanding of a collaborative, shared environment and goals. We expect it to be followed in spirit as much as in the letter. When in doubt, try to abide by [SendGrid’s cultural values](https://sendgrid.com/blog/employee-engagement-the-4h-way) defined by our “4H’s”: Happy, Hungry, Humble and Honest.
20+
This Code is not exhaustive or complete. It is not a rulebook; it serves to distill our common understanding of a collaborative, shared environment and goals. We expect it to be followed in spirit as much as in the letter. When in doubt, try to abide by [SendGrid’s cultural values](https://sendgrid.com/blog/employee-engagement-the-4h-way) defined by our “4H’s”: Happy, Hungry, Humble and Honest.
2121

2222
### Enforcement
2323
Most members of the SendGrid community always comply with this Code, not because of the existence of this Code, but because they have long experience participating in open source communities where the conduct described above is normal and expected. However, failure to observe this Code may be grounds for suspension, reporting the user for abuse or changing permissions for outside contributors.
@@ -30,12 +30,12 @@
3030
**Contact the Moderators** - You can reach the SendGrid moderators by emailing dx@sendgrid.com.
3131

3232
## Submission to SendGrid Repositories
33-
Finally, just a reminder, changes to the SendGrid repositories will only be accepted upon completion of the [SendGrid Contributor Agreement](https://cla.sendgrid.com).
33+
Finally, just a reminder, changes to the SendGrid repositories will only be accepted upon completion of the [SendGrid Contributor Agreement](https://cla.sendgrid.com).
3434

3535
## Attribution
3636

3737
SendGrid thanks the following, on which it draws for content and inspiration:
3838

39-
[Python Community Code of Conduct](https://www.python.org/psf/codeofconduct/)
40-
[Open Source Initiative General Code of Conduct](https://opensource.org/codeofconduct)
41-
[Apache Code of Conduct](https://www.apache.org/foundation/policies/conduct.html)
39+
[Python Community Code of Conduct](https://www.python.org/psf/codeofconduct/)
40+
[Open Source Initiative General Code of Conduct](https://opensource.org/codeofconduct)
41+
[Apache Code of Conduct](https://www.apache.org/foundation/policies/conduct.html)

Diff for: CONTRIBUTING.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ We welcome direct contributions to the sendgrid-python code base. Thank you!
6262
### Development Environment ###
6363
#### There are two ways to get set up: ####
6464
#### 1. Using Docker ####
65-
This is usually the easiest and fastest way to get set up.
65+
This is usually the easiest and fastest way to get set up.
6666
You can use our Docker image to avoid setting up the development environment yourself. See [USAGE.md](https://github.com/sendgrid/sendgrid-python/blob/master/docker/USAGE.md).
6767

6868
#### - OR - ####
@@ -191,10 +191,10 @@ Please run your code through:
191191
```bash
192192
# Clone your fork of the repo into the current directory
193193
git clone https://github.com/sendgrid/sendgrid-python
194-
194+
195195
# Navigate to the newly cloned directory
196196
cd sendgrid-python
197-
197+
198198
# Assign the original repo to a remote called "upstream"
199199
git remote add upstream https://github.com/sendgrid/sendgrid-python
200200
```
@@ -213,7 +213,7 @@ Please run your code through:
213213
git checkout -b <topic-branch-name>
214214
```
215215

216-
4. Commit your changes in logical chunks. Please adhere to these [git commits
216+
4. Commit your changes in logical chunks. Please adhere to these [git commit
217217
message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
218218
or your code is unlikely to be merged into the main project. Use Git's
219219
[interactive rebase](https://help.github.com/articles/interactive-rebase)

Diff for: TROUBLESHOOTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ If you are using a [requirements file](https://pip.readthedocs.io/en/1.1/require
9595
<a name="versions"></a>
9696
## Versioning Convention
9797

98-
We follow the MAJOR.MINOR.PATCH versioning scheme as described by [SemVer.org](http://semver.org). Therefore, we recommend that you always pin (or vendor) the particular version you are working with your code and never auto-update to the latest version. Especially when there is a MAJOR point release since that is guaranteed to be a breaking change. Changes are documented in the [CHANGELOG](https://github.com/sendgrid/sendgrid-python/blob/master/CHANGELOG.md) and [releases](https://github.com/sendgrid/sendgrid-python/releases) section.
98+
We follow the MAJOR.MINOR.PATCH versioning scheme as described by [SemVer.org](http://semver.org). Therefore, we recommend that you always pin (or vendor) the particular version you are working with in your code and never auto-update to the latest version. Especially when there is a MAJOR point release since that is guaranteed to be a breaking change. Changes are documented in the [CHANGELOG](https://github.com/sendgrid/sendgrid-python/blob/master/CHANGELOG.md) and [releases](https://github.com/sendgrid/sendgrid-python/releases) section.
9999

100100
<a name="request-body"></a>
101101
## Viewing the Request Body

Diff for: use_cases/aws.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
This tutorial explains how to set up a simple "Hello Email" app on AWS, using the AWS CodeStar service.
44

5-
We'll be creating a basic web service to send an email via SendGrid. The application will run on AWS Lambda, and the "endpoint" will be via AWS API Gateway.
5+
We'll be creating a basic web service to send email via SendGrid. The application will run on AWS Lambda, and the "endpoint" will be via AWS API Gateway.
66

77
The neat thing is that CodeStar provides all of this in a pre-configured package. We just have to make some config changes and push our code.
88

9-
Once this tutorial is complete, you'll have a basic web service for sending an email that can be invoked via a link to your newly created API endpoint.
9+
Once this tutorial is complete, you'll have a basic web service for sending email that can be invoked via a link to your newly created API endpoint.
1010

1111
### Prerequisites
1212
Python 2.6, 2.7, 3.4, or 3.5 are supported by the sendgrid Python library, however, I was able to utilize 3.6 with no issue.
@@ -21,13 +21,13 @@ Before starting this tutorial, you will need to have access to an AWS account in
2121
### Create AWS CodeStar Project
2222
Log in to your AWS account and go to the AWS CodeStar service. Click "Start a project". For this tutorial we're going to choose a Python Web service, utilizing AWS Lambda. You can use the filters on the left-hand side of the UI to narrow down the available choices.
2323

24-
After you've selected the template, you're asked to provide a name for your project. Go ahead and name it "hello-email". Once you've entered a name, click "Create Project" in the lower right-hand corner. You can then choose which tools you want to use to interact with the project. For this tutorial, we'll be choosing the "Command Line".
24+
After you've selected the template, you're asked to provide a name for your project. Go ahead and name it "hello-email". Once you've entered a name, click "Create Project" in the lower right-hand corner. You can then choose which tools you want to use to interact with the project. For this tutorial, we'll be choosing "Command Line".
2525

26-
Once that is completed, you'll be given some basic steps to get Git installed and setup, and instructions for connecting to the AWS CodeCommit(git) repository. You can either use HTTPS or SSH. Instructions for setting up either are provided.
26+
Once that is completed, you'll be given some basic steps to get Git installed and setup, and instructions for connecting to the AWS CodeCommit(git) repository. You can either use HTTPS or SSH. Instructions for setting up either are provided.
2727

2828
Go ahead and clone the Git repository link after it is created. You may need to click "Skip" in the lower right-hand corner to proceed.
2929

30-
Once that's done, you've successfully created a CodeStar project! You should be at the dashboard, with a view of the wiki, changelog, build a pipeline, and application endpoint.
30+
Once that's done, you've successfully created a CodeStar project! You should be at the dashboard, with a view of the wiki, changelog, build pipeline, and application endpoint.
3131

3232
### Create SendGrid API Key
3333
Log in to your SendGrid account. Click on your username on the left-hand side of the UI and choose "Setup Guide" from the drop-down menu. On the "Welcome" menu, choose "Send Your First Email", and then "Integrate using our Web API or SMTP relay." Choose "Web API" as the recommended option on the next screen, as we'll be using that for this tutorial. For more information about creating API keys, see https://sendgrid.com/docs/Classroom/Send/How_Emails_Are_Sent/api_keys.html
@@ -44,7 +44,7 @@ For the rest of the tutorial, we'll be working out of the Git repository we clon
4444
```
4545
$ cd hello-email
4646
```
47-
note: this assumes you cloned the Git repo inside your current directory. My directory is:
47+
note: this assumes you cloned the Git repo inside your current directory. My directory is:
4848

4949
```
5050
~/projects/hello-email
@@ -100,7 +100,7 @@ virtualenv venv
100100
source ./venv/bin/activate
101101
```
102102

103-
Prior to being able to deploy our Python code, we'll need to install the sendgrid Python module *locally*. One of the idiosyncrasies of AWS Lambda is that all library and module dependencies that aren't part of the standard library have to be included with the code/build artifact. Virtual environments do not translate to the Lambda runtime environment.
103+
Prior to being able to deploy our Python code, we'll need to install the sendgrid Python module *locally*. One of the idiosyncrasies of AWS Lambda is that all library and module dependencies that aren't part of the standard library have to be included with the code/build artifact. Virtual environments do not translate to the Lambda runtime environment.
104104

105105
In the root project directory, run the following command:
106106
```
@@ -157,7 +157,7 @@ $ git commit -m 'hello-email app'
157157
$ git push
158158
```
159159

160-
Once the code is successfully pushed, head back to the AWS CodeStar dashboard for your project. After your commit successfully registers, an automated build and deployment process should kick off.
160+
Once the code is successfully pushed, head back to the AWS CodeStar dashboard for your project. After your commit successfully registers, an automated build and deployment process should kick off.
161161

162162
One more step left before our application will work correctly. After your code has bee deployed, head to the AWS Lambda console. Click on your function name, which should start with `awscodestar-hello-email-lambda-`, or similar.
163163

@@ -167,6 +167,6 @@ Scroll down to the "Environment Variables" section. Here we need to populate our
167167
SENDGRID_API_KEY
168168
```
169169

170-
Now, go back to your project dashboard in CodeStar. Click on the link under "Application endpoints". After a moment, you should be greeted with JSON output indicating an email was successfully sent.
170+
Now, go back to your project dashboard in CodeStar. Click on the link under "Application endpoints". After a moment, you should be greeted with JSON output indicating an email was successfully sent.
171171

172-
Congratulations, you've just used serverless technology to create an email sending the app in AWS!
172+
Congratulations, you've just used serverless technology to create an email sending app in AWS!

Diff for: use_cases/django.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Create a Django app to send an email with SendGrid
1+
# Create a Django app to send email with SendGrid
22

33
This tutorial explains how we set up a simple Django app to send an email with the SendGrid Python SDK and how we deploy our app to Heroku.
44

@@ -119,7 +119,7 @@ $ python manage.py migrate
119119
$ python manage.py runserver
120120
```
121121

122-
By default, it starts the development server at `http://127.0.0.1:8000/`. To test if we can send an email or not, go to `http://127.0.0.1:8000/sendgrid/`. If it works, we should see the page says "Email Sent!".
122+
By default, it starts the development server at `http://127.0.0.1:8000/`. To test if we can send email or not, go to `http://127.0.0.1:8000/sendgrid/`. If it works, we should see the page says "Email Sent!".
123123

124124
**Note:** If you use `test@example.com` as your from email, it's likely to go to your spam folder. To have the emails show up in your inbox, try using an email address at the domain you registered your SendGrid account.
125125

@@ -198,4 +198,4 @@ $ git commit -am "Create simple Hello Email Django app using SendGrid"
198198
$ git push heroku master
199199
```
200200

201-
After that, let's verify if our app is working or not by accessing the root domain of your Heroku app. You should see the page says "Email Sent!" and on the Activity Feed page in the SendGrid dashboard, you should see a new feed with the email you set in the code.
201+
After that, let's verify if our app is working or not by accessing the root domain of your Heroku app. You should see the page says "Email Sent!" and on the Activity Feed page in the SendGrid dashboard, you should see a new feed with the email you set in the code.

Diff for: use_cases/flask_heroku.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Create a Flask app to send an email with SendGrid
1+
# Create a Flask app to send email with SendGrid
22

33
This tutorial explains how to deploy a simple Flask app, to send an email using the SendGrid Python SDK, on Heroku.
44

0 commit comments

Comments
 (0)