Skip to content

Commit 3c3277b

Browse files
chore: update GitHub branch references to use HEAD (#929)
1 parent 23c33b0 commit 3c3277b

21 files changed

+96
-96
lines changed

CHANGELOG.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ All notable changes to this project will be documented in this file.
152152

153153
### Added
154154
- Twilio SendGrid branding
155-
- [Twilio SMS example](https://github.com/sendgrid/sendgrid-python/blob/master/use_cases/sms.md)
155+
- [Twilio SMS example](use_cases/sms.md)
156156
- Updated CLA process
157157

158158
## [6.0.0] - 2019-04-02 ##
@@ -162,7 +162,7 @@ All notable changes to this project will be documented in this file.
162162
- The `Mail` helper signature has changed.
163163
- Setting up a `SendGridAPIClient` has changed.
164164

165-
Please see the [use cases documentation](https://github.com/sendgrid/sendgrid-python/blob/master/use_cases/README.md) for implemenation details.
165+
Please see the [use cases documentation](use_cases/README.md) for implemenation details.
166166

167167
This refactor was based on [this issue](https://github.com/sendgrid/sendgrid-python/issues/347). BIG thanks to all of those who [participated](https://github.com/sendgrid/sendgrid-python/issues/323) in shaping this release.
168168

@@ -198,7 +198,7 @@ In particular, BIG THANKS to:
198198
- [PR #488](https://github.com/sendgrid/sendgrid-python/pull/488): Fix similar code issue in mail.py helper (BIG thanks to [@adiman9](https://github.com/adiman9))
199199
- [PR #496](https://github.com/sendgrid/sendgrid-python/pull/496): Fix issues in sendgrid/helpers/mail/mail.py (BIG thanks to [@galihmelon](https://github.com/galihmelon))
200200
- [PR #510](https://github.com/sendgrid/sendgrid-python/pull/510): Fix similar code issue in sendgrid/helpers/mail/mail.py (BIG thanks to [@nanspro](https://github.com/nanspro))
201-
- [PR #524](https://github.com/sendgrid/sendgrid-python/pull/524): Fix master failure on travis (relating to ASM raise-assertion). (BIG thanks to [@extemporalgenome](https://github.com/extemporalgenome))
201+
- [PR #524](https://github.com/sendgrid/sendgrid-python/pull/524): Fix main failure on travis (relating to ASM raise-assertion). (BIG thanks to [@extemporalgenome](https://github.com/extemporalgenome))
202202

203203
### Added
204204
- [PR #666](https://github.com/sendgrid/sendgrid-python/pull/666): Created First-timers.md File (BIG thanks to [@jaykay12](https://github.com/jaykay12))
@@ -316,7 +316,7 @@ Removed the trailing white spaces. Big thanks to [Siddaram Halli](https://github
316316
## [5.0.0] - 2017-08-11
317317
### BREAKING CHANGE
318318
- The breaking change actually happened in [version 4.2.1](https://github.com/sendgrid/sendgrid-python/releases/tag/v4.2.1), where I mistakenly applied a patch version bump. See issues #328 and #321 for details.
319-
- This version (5.0.0) replaces error handling via HTTPError from urllib in favor of custom error handling via the [HTTPError class](https://github.com/sendgrid/python-http-client/blob/master/python_http_client/exceptions.py) as was the case in version 4.2.0.
319+
- This version (5.0.0) replaces error handling via HTTPError from urllib in favor of custom error handling via the [HTTPError class](https://github.com/sendgrid/python-http-client/blob/HEAD/python_http_client/exceptions.py) as was the case in version 4.2.0.
320320

321321
## [4.2.1] - 2017-08-03 ##
322322
### Fixed
@@ -337,7 +337,7 @@ Removed the trailing white spaces. Big thanks to [Siddaram Halli](https://github
337337
### BREAKING CHANGE
338338
- Pull #244 [refactor helpers using property getter/setter](https://github.com/sendgrid/sendgrid-python/pull/244/files)
339339
- Big thanks to [Denis Vlasov](https://github.com/denis90) for the pull request!
340-
- The changes break the implementation of the [Mail Helper](https://github.com/sendgrid/sendgrid-python/tree/master/sendgrid/helpers/mail) `Mail()` class
340+
- The changes break the implementation of the [Mail Helper](sendgrid/helpers/mail) `Mail()` class
341341
- `set_from()` is now the property `from_email`
342342
- `set_subject()` is now the property `subject`
343343
- `set_template_id()` is now the property `template_id`
@@ -426,7 +426,7 @@ Removed the trailing white spaces. Big thanks to [Siddaram Halli](https://github
426426
## [3.2.2] - 2016-08-23 ##
427427
### Added
428428
- Table of Contents in the README
429-
- Added a [USE_CASES.md](https://github.com/sendgrid/sendgrid-python/blob/master/USE_CASES.md) section, with the first use case example for transactional templates
429+
- Added a [USE_CASES.md](USE_CASES.md) section, with the first use case example for transactional templates
430430

431431
## [3.2.1] - 2016-08-17 ##
432432
### Fixed
@@ -448,7 +448,7 @@ Removed the trailing white spaces. Big thanks to [Siddaram Halli](https://github
448448

449449
## [3.1.8] - 2016-07-25 ##
450450
### Added
451-
- [Troubleshooting](https://github.com/sendgrid/sendgrid-python/blob/master/TROUBLESHOOTING.md) section
451+
- [Troubleshooting](TROUBLESHOOTING.md) section
452452

453453
## [3.1.7] - 2016-07-25 ##
454454
### Added

CONTRIBUTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ source .env
8787

8888
#### Execute
8989

90-
See the [examples folder](https://github.com/sendgrid/sendgrid-python/tree/master/examples) to get started quickly.
90+
See the [examples folder](examples) to get started quickly.
9191

9292
If testing from the root directory of this repo, create a new file (e.g. test.py) and replace `import sendgrid` with `from sendgrid import *`
9393

@@ -104,7 +104,7 @@ If testing from the root directory of this repo, create a new file (e.g. test.py
104104

105105
The PR must pass all the tests before it is reviewed.
106106

107-
All test files are in the [`test`](https://github.com/sendgrid/sendgrid-python/test) directory. For the purposes of contributing to this repo, please update the [`test_sendgrid.py`](https://github.com/sendgrid/sendgrid-python/tree/master/test/test_sendgrid.py) file with unit tests as you modify the code.
107+
All test files are in the [`test`](test) directory. For the purposes of contributing to this repo, please update the [`test_sendgrid.py`](test/test_sendgrid.py) file with unit tests as you modify the code.
108108

109109
The integration tests require a Twilio SendGrid mock API in order to execute. We've simplified setting this up using Docker to run the tests. You will just need [Docker Desktop](https://docs.docker.com/get-docker/) and `make`.
110110

@@ -165,7 +165,7 @@ Please run your code through:
165165
5. Locally merge (or rebase) the upstream development branch into your topic branch:
166166

167167
```bash
168-
git pull [--rebase] upstream master
168+
git pull [--rebase] upstream main
169169
```
170170

171171
6. Push your topic branch up to your fork:
@@ -175,7 +175,7 @@ Please run your code through:
175175
```
176176

177177
7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
178-
with a clear title and description against the `master` branch. All tests must be passing before we will review the PR.
178+
with a clear title and description against the `main` branch. All tests must be passing before we will review the PR.
179179

180180
## Code Reviews
181181
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/).

FIRST_TIMERS.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,13 +54,13 @@ Kindly make sure, to check for any duplicate issues raised by fellow contributor
5454

5555
**Step 4:** Commit the changes in logical chunks & add commit messages strictly following [this](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
5656

57-
**Step 5:** Run all test locally, [for more info](https://github.com/sendgrid/sendgrid-python/blob/master/CONTRIBUTING.md#testing)
57+
**Step 5:** Run all test locally, [for more info](CONTRIBUTING.md#testing)
5858

59-
**Step 6:** Locally merge your the upstream development branch into your topic-branch using `git pull [--rebase] upstream master`
59+
**Step 6:** Locally merge your the upstream development branch into your topic-branch using `git pull [--rebase] upstream main`
6060

6161
**Step 7:** Push the topic branch up to your fork using `git push origin <topic-branch-name>`
6262

63-
**Step 8:** Open a Pull Request with clear title and description against the master branch.
63+
**Step 8:** Open a Pull Request with clear title and description against the main branch.
6464

6565
<a name="reviews"></a>
6666
## Be Patient & Wait for Reviews

README.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
![SendGrid Logo](https://uiux.s3.amazonaws.com/2016-logos/email-logo%402x.png)
1+
![SendGrid Logo](twilio_sendgrid_logo.png)
22

3-
[![Travis Badge](https://travis-ci.org/sendgrid/sendgrid-python.svg?branch=master)](https://travis-ci.org/sendgrid/sendgrid-python)
4-
[![codecov](https://img.shields.io/codecov/c/github/sendgrid/sendgrid-python/master.svg?style=flat-square&label=Codecov+Coverage)](https://codecov.io/gh/sendgrid/sendgrid-python)
3+
[![Travis Badge](https://travis-ci.org/sendgrid/sendgrid-python.svg?branch=main)](https://travis-ci.org/sendgrid/sendgrid-python)
4+
[![codecov](https://img.shields.io/codecov/c/github/sendgrid/sendgrid-python/main.svg?style=flat-square&label=Codecov+Coverage)](https://codecov.io/gh/sendgrid/sendgrid-python)
55
[![Docker Badge](https://img.shields.io/docker/automated/sendgrid/sendgrid-python.svg)](https://hub.docker.com/r/sendgrid/sendgrid-python/)
66
[![Email Notifications Badge](https://dx.sendgrid.com/badge/python)](https://dx.sendgrid.com/newsletter/python)
77
[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE.md)
@@ -15,7 +15,7 @@
1515

1616
Version 3.X.X+ of this library provides full support for all SendGrid [Web API v3](https://sendgrid.com/docs/API_Reference/Web_API_v3/index.html) endpoints, including the new [v3 /mail/send](https://sendgrid.com/blog/introducing-v3mailsend-sendgrids-new-mail-endpoint).
1717

18-
This library represents the beginning of a new path for SendGrid. We want this library to be community driven and SendGrid led. We need your help to realize this goal. To help make sure we are building the right things in the right order, we ask that you create [issues](https://github.com/sendgrid/sendgrid-python/issues) and [pull requests](https://github.com/sendgrid/sendgrid-python/blob/master/CONTRIBUTING.md) or simply upvote or comment on existing issues or pull requests.
18+
This library represents the beginning of a new path for SendGrid. We want this library to be community driven and SendGrid led. We need your help to realize this goal. To help make sure we are building the right things in the right order, we ask that you create [issues](https://github.com/sendgrid/sendgrid-python/issues) and [pull requests](CONTRIBUTING.md) or simply upvote or comment on existing issues or pull requests.
1919

2020
Please browse the rest of this README for further detail.
2121

@@ -82,7 +82,7 @@ pip install sendgrid
8282

8383
## Hello Email
8484

85-
The following is the minimum needed code to send an email with the [/mail/send Helper](https://github.com/sendgrid/sendgrid-python/tree/master/sendgrid/helpers/mail) ([here](https://github.com/sendgrid/sendgrid-python/blob/master/examples/helpers/mail_example.py#L9) is a full example):
85+
The following is the minimum needed code to send an email with the [/mail/send Helper](sendgrid/helpers/mail) ([here](examples/helpers/mail_example.py#L9) is a full example):
8686

8787
### With Mail Helper Class
8888

@@ -103,11 +103,11 @@ print(response.body)
103103
print(response.headers)
104104
```
105105

106-
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.
106+
The `Mail` constructor creates a [personalization object](https://sendgrid.com/docs/Classroom/Send/v3_Mail_Send/personalizations.html) for you. [Here](examples/helpers/mail_example.py#L16) is an example of how to add it.
107107

108108
### Without Mail Helper Class
109109

110-
The following is the minimum needed code to send an email without the /mail/send Helper ([here](https://github.com/sendgrid/sendgrid-python/blob/master/examples/mail/mail.py#L27) is a full example):
110+
The following is the minimum needed code to send an email without the /mail/send Helper ([here](examples/mail/mail.py#L27) is a full example):
111111

112112
```python
113113
import sendgrid
@@ -170,29 +170,29 @@ print(response.headers)
170170
<a name="inbound"></a>
171171
# Processing Inbound Email
172172

173-
Please see [our helper](https://github.com/sendgrid/sendgrid-python/tree/master/sendgrid/helpers/inbound) for utilizing our Inbound Parse webhook.
173+
Please see [our helper](sendgrid/helpers/inbound) for utilizing our Inbound Parse webhook.
174174

175175
<a name="usage"></a>
176176
# Usage
177177

178178
- [SendGrid Documentation](https://sendgrid.com/docs/API_Reference/index.html)
179-
- [Library Usage Documentation](https://github.com/sendgrid/sendgrid-python/tree/master/USAGE.md)
180-
- [Example Code](https://github.com/sendgrid/sendgrid-python/tree/master/examples)
179+
- [Library Usage Documentation](USAGE.md)
180+
- [Example Code](examples)
181181
- [How-to: Migration from v2 to v3](https://sendgrid.com/docs/Classroom/Send/v3_Mail_Send/how_to_migrate_from_v2_to_v3_mail_send.html)
182-
- [v3 Web API Mail Send Helper](https://github.com/sendgrid/sendgrid-python/tree/master/sendgrid/helpers/mail) - build a request object payload for a v3 /mail/send API call.
183-
- [Processing Inbound Email](https://github.com/sendgrid/sendgrid-python/tree/master/sendgrid/helpers/inbound)
182+
- [v3 Web API Mail Send Helper](sendgrid/helpers/mail) - build a request object payload for a v3 /mail/send API call.
183+
- [Processing Inbound Email](sendgrid/helpers/inbound)
184184

185185
<a name="use-cases"></a>
186186
# Use Cases
187187

188-
[Examples of common API use cases](https://github.com/sendgrid/sendgrid-python/blob/master/use_cases/README.md), such as how to send an email with a transactional template.
188+
[Examples of common API use cases](use_cases/README.md), such as how to send an email with a transactional template.
189189

190190
<a name="announcements"></a>
191191
# Announcements
192192

193193
Please see our announcement regarding [breaking changes](https://github.com/sendgrid/sendgrid-python/issues/217). Your support is appreciated!
194194

195-
All updates to this library are documented in our [CHANGELOG](https://github.com/sendgrid/sendgrid-python/blob/master/CHANGELOG.md) and [releases](https://github.com/sendgrid/sendgrid-python/releases). You may also subscribe to email [release notifications](https://dx.sendgrid.com/newsletter/java) for releases and breaking changes.
195+
All updates to this library are documented in our [CHANGELOG](CHANGELOG.md) and [releases](https://github.com/sendgrid/sendgrid-python/releases). You may also subscribe to email [release notifications](https://dx.sendgrid.com/newsletter/java) for releases and breaking changes.
196196

197197
<a name="roadmap"></a>
198198
# Roadmap
@@ -202,19 +202,19 @@ If you are interested in the future direction of this project, please take a loo
202202
<a name="contribute"></a>
203203
# How to Contribute
204204

205-
We encourage contribution to our libraries (you might even score some nifty swag), please see our [CONTRIBUTING](https://github.com/sendgrid/sendgrid-python/blob/master/CONTRIBUTING.md) guide for details.
205+
We encourage contribution to our libraries (you might even score some nifty swag), please see our [CONTRIBUTING](CONTRIBUTING.md) guide for details.
206206

207207
Quick links:
208208

209-
- [Feature Request](https://github.com/sendgrid/sendgrid-python/blob/master/CONTRIBUTING.md#feature-request)
210-
- [Bug Reports](https://github.com/sendgrid/sendgrid-python/blob/master/CONTRIBUTING.md#submit-a-bug-report)
211-
- [Improvements to the Codebase](https://github.com/sendgrid/sendgrid-python/blob/master/CONTRIBUTING.md#improvements-to-the-codebase)
212-
- [Review Pull Requests](https://github.com/sendgrid/sendgrid-python/blob/master/CONTRIBUTING.md#code-reviews)
209+
- [Feature Request](CONTRIBUTING.md#feature-request)
210+
- [Bug Reports](CONTRIBUTING.md#submit-a-bug-report)
211+
- [Improvements to the Codebase](CONTRIBUTING.md#improvements-to-the-codebase)
212+
- [Review Pull Requests](CONTRIBUTING.md#code-reviews)
213213

214214
<a name="troubleshooting"></a>
215215
# Troubleshooting
216216

217-
Please see our [troubleshooting guide](https://github.com/sendgrid/sendgrid-python/blob/master/TROUBLESHOOTING.md) for common library issues.
217+
Please see our [troubleshooting guide](TROUBLESHOOTING.md) for common library issues.
218218

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

0 commit comments

Comments
 (0)