Skip to content

Commit 6728946

Browse files
authored
docs: document change in top-level dependencies (#915)
This change adds information about top-level dependencies of the package to various places of its docs. Follow-up to #914
1 parent 84c3193 commit 6728946

File tree

4 files changed

+21
-17
lines changed

4 files changed

+21
-17
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ You can use our Docker image to avoid setting up the development environment you
7575

7676
- Python 2.7 and 3.4+
7777
- [python_http_client](https://github.com/sendgrid/python-http-client)
78+
- [ecdsa_python](https://github.com/starkbank/ecdsa-python)
7879

7980
##### Initial setup: #####
8081

FIRST_TIMERS.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
- [Setting up the Development Environment](#setup)
77
- [Proposing Change through a Pull Request](#pr)
88
- [Be Patient & Wait for reviews](#reviews)
9-
9+
1010
<a name="explore"></a>
1111
### Explore Twilio SendGrid
1212
Step 1: Get yourself Access to Twilio SendGrid API Service absolutely free from [here](https://sendgrid.com/free/?source=sendgrid-python)\
@@ -15,8 +15,8 @@ Step 2: Get familiar with Twilio SendGrid Service
1515
- Set up your [Twilio SendGrid API Key](https://app.sendgrid.com/settings/api_keys) to your local workspace [using](https://github.com/sendgrid/sendgrid-python#setup-environment-variables)
1616
- Install Twilio SendGrid to your workspace using `pip install sendgrid`
1717
- Copy & Run few sample programs from [here](https://github.com/sendgrid/sendgrid-python#hello-email)
18-
19-
18+
19+
2020
<a name="issues"></a>
2121
### Raise Issues
2222
Twilio SendGrid uses GitHub as the content management service so, all the issues related to the project be it some feature request or a bug report, all are reported at the [GitHub Issue Tracker](https://github.com/sendgrid/sendgrid-python/issues)\
@@ -27,16 +27,16 @@ Step 2: Get familiar with Twilio SendGrid Service
2727
If you encounter any sort of bug or abnormal behavior, feel free to inform the community after performing the following checks:
2828
- Update to the latest version & check if the bug persists
2929
- Check the Issue Tracker for any similar bug report
30-
30+
3131
Finally fill up the Bug Report Template & Open the Issue highlighting your encountered bug & detailed steps to regenerate the bug.
32-
32+
3333
<a name="setup"></a>
3434
### Setting up the Development Environment
3535
- **Using Docker**\
3636
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)
37-
37+
3838
- **Setting up Locally**\
39-
Step 1: Install the Prerequistes: Any Version of Python(2.6 through 3.6) & [python_http_client](https://github.com/sendgrid/python-http-client)\
39+
Step 1: Install the Prerequistes: Any Version of Python (2.6 through 3.6) and both [python_http_client](https://github.com/sendgrid/python-http-client) and [ecdsa_python](https://github.com/starkbank/ecdsa-python)\
4040
Step 2: Get a local copy of repository using `git clone https://github.com/sendgrid/sendgrid-python.git`\
4141
Step 3: Set your [Twilio SendGrid API Key](https://app.sendgrid.com/settings/api_keys) to your local workspace using\
4242
`echo "export SENDGRID_API_KEY='YOUR_API_KEY'" > sendgrid.env`\
@@ -46,28 +46,28 @@ Step 2: Get familiar with Twilio SendGrid Service
4646
- **/examples** contains *Working examples that demonstrate usage*
4747
- **/tests** contains *the unit and profiling tests*
4848
- **/sendgrid** contains *the Web API v3 client ie sendgrid.py and other files*.
49-
50-
49+
50+
5151
<a name="pr"></a>
5252
## Proposing Change through a Pull Request
5353
**Step 1:** Fork the project & Clone your fork using `git clone https://github.com/<USERNAME>/sendgrid-python.git`
54-
54+
5555
**Step 2:** Reconfigure the remotes using `cd sendgrid-python` and `git remote add upstream https://github.com/sendgrid/sendgrid-python.git`
56-
56+
5757
**Step 3:** Create a new branch for your modifications using `git checkout -b <topic-branch-name>`
58-
58+
5959
**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)
60-
60+
6161
**Step 5:** Run all test locally, [for more info](https://github.com/sendgrid/sendgrid-python/blob/master/CONTRIBUTING.md#testing)
62-
62+
6363
**Step 6:** Locally merge your the upstream development branch into your topic-branch using `git pull [--rebase] upstream master`
64-
64+
6565
**Step 7:** Push the topic branch up to your fork using `git push origin <topic-branch-name>`
66-
66+
6767
**Step 8:** Open a Pull Request with clear title and description against the master branch.
6868

6969
<a name="reviews"></a>
7070
## Be Patient & Wait for Reviews
7171
Kindly be patient & follow the suggestions as provided by the peer reviewers. Make required amendments & changes to the PR as asked.
72-
72+
7373
## [Explore New Issues to work upon](https://github.com/sendgrid/sendgrid-python/labels/difficulty%3A%20easy)

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ pip install sendgrid
7777
## Dependencies
7878

7979
- [Python-HTTP-Client](https://github.com/sendgrid/python-http-client)
80+
- [ECDSA-Python](https://github.com/starkbank/ecdsa-python)
8081

8182

8283
<a name="quick-start"></a>

README.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,7 @@ Dependencies
9393
------------
9494

9595
- `Python-HTTP-Client`_
96+
- `ECDSA-Python`_
9697

9798
Quick Start
9899
===========
@@ -272,6 +273,7 @@ License
272273
.. _Twilio account: https://www.twilio.com/try-twilio?source=sendgrid-python
273274
.. _SENDGRID_API_KEY: https://app.sendgrid.com/settings/api_keys
274275
.. _Python-HTTP-Client: https://github.com/sendgrid/python-http-client
276+
.. _ECDSA-Python: https://github.com/starkbank/ecdsa-python
275277
.. _/mail/send Helper: https://github.com/sendgrid/sendgrid-python/tree/master/sendgrid/helpers/mail
276278
.. _personalization object: https://sendgrid.com/docs/Classroom/Send/v3_Mail_Send/personalizations.html
277279
.. _Fluent Interface: https://sendgrid.com/blog/using-python-to-implement-a-fluent-interface-to-any-rest-api/

0 commit comments

Comments
 (0)