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

docs: document change in top-level dependencies #915

Merged
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
1 change: 1 addition & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ You can use our Docker image to avoid setting up the development environment you

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

##### Initial setup: #####

Expand Down
34 changes: 17 additions & 17 deletions FIRST_TIMERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
- [Setting up the Development Environment](#setup)
- [Proposing Change through a Pull Request](#pr)
- [Be Patient & Wait for reviews](#reviews)

<a name="explore"></a>
### Explore Twilio SendGrid
Step 1: Get yourself Access to Twilio SendGrid API Service absolutely free from [here](https://sendgrid.com/free/?source=sendgrid-python)\
Expand All @@ -15,8 +15,8 @@ Step 2: Get familiar with Twilio SendGrid Service
- 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)
- Install Twilio SendGrid to your workspace using `pip install sendgrid`
- Copy & Run few sample programs from [here](https://github.com/sendgrid/sendgrid-python#hello-email)


<a name="issues"></a>
### Raise Issues
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)\
Expand All @@ -27,16 +27,16 @@ Step 2: Get familiar with Twilio SendGrid Service
If you encounter any sort of bug or abnormal behavior, feel free to inform the community after performing the following checks:
- Update to the latest version & check if the bug persists
- Check the Issue Tracker for any similar bug report

Finally fill up the Bug Report Template & Open the Issue highlighting your encountered bug & detailed steps to regenerate the bug.

<a name="setup"></a>
### Setting up the Development Environment
- **Using Docker**\
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)

- **Setting up Locally**\
Step 1: Install the Prerequistes: Any Version of Python(2.6 through 3.6) & [python_http_client](https://github.com/sendgrid/python-http-client)\
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)\
Step 2: Get a local copy of repository using `git clone https://github.com/sendgrid/sendgrid-python.git`\
Step 3: Set your [Twilio SendGrid API Key](https://app.sendgrid.com/settings/api_keys) to your local workspace using\
`echo "export SENDGRID_API_KEY='YOUR_API_KEY'" > sendgrid.env`\
Expand All @@ -46,28 +46,28 @@ Step 2: Get familiar with Twilio SendGrid Service
- **/examples** contains *Working examples that demonstrate usage*
- **/tests** contains *the unit and profiling tests*
- **/sendgrid** contains *the Web API v3 client ie sendgrid.py and other files*.


<a name="pr"></a>
## Proposing Change through a Pull Request
**Step 1:** Fork the project & Clone your fork using `git clone https://github.com/<USERNAME>/sendgrid-python.git`

**Step 2:** Reconfigure the remotes using `cd sendgrid-python` and `git remote add upstream https://github.com/sendgrid/sendgrid-python.git`

**Step 3:** Create a new branch for your modifications using `git checkout -b <topic-branch-name>`

**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)

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

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

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

**Step 8:** Open a Pull Request with clear title and description against the master branch.

<a name="reviews"></a>
## Be Patient & Wait for Reviews
Kindly be patient & follow the suggestions as provided by the peer reviewers. Make required amendments & changes to the PR as asked.

## [Explore New Issues to work upon](https://github.com/sendgrid/sendgrid-python/labels/difficulty%3A%20easy)
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ pip install sendgrid
## Dependencies

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


<a name="quick-start"></a>
Expand Down
2 changes: 2 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@ Dependencies
------------

- `Python-HTTP-Client`_
- `ECDSA-Python`_

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