CONTRIBUTING.md

Hello! Thank you for choosing to help contribute to one of the Twilio SendGrid open source projects. There are many ways you can contribute and help is always welcome. We simply ask that you follow the following contribution policies.

All third party contributors acknowledge that any contributions they provide will be made under the same open source license that the open source project is provided under.

• Improvements to the Codebase
  • Development Environment
    • Install and Run Locally
      • Prerequisites
      • Initial setup:
      • Execute:
• Understanding the Code Base
• Testing
• Testing Multiple Versions of Python
  • Prerequisites:
  • Initial setup:
  • Execute:
• Style Guidelines & Naming Conventions
• Creating a Pull Request
• Code Reviews

There are a few ways to contribute, which we'll enumerate below:

Improvements to the Codebase

We welcome direct contributions to the python-http-client code base. Thank you!

Please note that we utilize the Gitflow Workflow for Git to help keep project development organized and consistent.

Development Environment

Install and Run Locally

Prerequisites

• Python 2.7 and 3.4+
• There are no external dependencies

Initial setup:

git clone https://github.com/sendgrid/python-http-client.git
cd python-http-client

Execute:

See the examples folder to get started quickly.

Understanding the Code Base

/examples

Working examples that demonstrate usage.

/tests

Unit and profiling tests.

/python_http_client/client.py

An HTTP client with a fluent interface using method chaining and reflection. By returning self on getattr, we can dynamically build the URL using method chaining and getattr allows us to dynamically receive the method calls to achieve reflection.

This allows for the following mapping from a URL to a method chain:

/api_client/{api_key_id}/version maps to client.api_client._(api_key_id).version.<method>() where is a HTTP verb.

/python_http_client/config.py

Loads the environment variables, if applicable.

Testing

All PRs require passing tests before the PR will be reviewed.

All test files are in the tests directory.

For the purposes of contributing to this repo, please update the test_unit.py file with unit tests as you modify the code.

python -m unittest discover -v

Testing Multiple Versions of Python

All PRs require passing tests before the PR will be reviewed.

Prerequisites:

The above local "Initial setup" is complete

• pyenv
• tox

Initial setup:

Add eval "$(pyenv init -)" to your shell environment (.profile, .bashrc, etc) after installing tox, you only need to do this once.

pyenv install 2.7.11
pyenv install 3.4.3
pyenv install 3.5.2
pyenv install 3.6.0
python setup.py install
pyenv local 3.6.0 3.5.2 3.4.3 2.7.8
pyenv rehash

Execute:

source venv/bin/activate
tox

Style Guidelines & Naming Conventions

Generally, we follow the style guidelines as suggested by the official language. However, we ask that you conform to the styles that already exist in the library. If you wish to deviate, please explain your reasoning.

• PEP8

Please run your code through:

• pyflakes
• pylint
• pep8

Creating a Pull Request

1. Fork the project, clone your fork, and configure the remotes:

   # Clone your fork of the repo into the current directory
   git clone https://github.com/sendgrid/python-http-client
   # Navigate to the newly cloned directory
   cd python-http-client
   # Assign the original repo to a remote called "upstream"
   git remote add upstream https://github.com/sendgrid/python-http-client

2. If you cloned a while ago, get the latest changes from upstream:

   git checkout <dev-branch>
   git pull upstream <dev-branch>

3. Create a new topic branch off the development branch to

   contain your feature, change, or fix:

   git checkout development
   git checkout -b <topic-branch-name>

4. Commit your changes in logical chunks. Please adhere to these git commit message guidelines or your code is unlikely to be merged into the main project. Use Git's interactive rebase feature to tidy up your commits before making them public.

4a. Create tests.

4b. Create or update the example code that demonstrates the functionality of this change to the code.

5. Locally merge (or rebase) the upstream development branch into your topic branch:

   git pull [--rebase] upstream development

6. Push your topic branch up to your fork:

   git push origin <topic-branch-name>

7. Open a Pull Request with a clear title and description against the development branch. All tests must be passing before we will review the PR.

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.