HTTP REST client, simplified for Python
Project description
Quickly and easily access any RESTful or RESTful-like API.
If you are looking for the SendGrid API client library, please see this repo.
Table of Contents
# Installation
Prerequisites
Python version 2.6, 2.7, 3.4, 3.5 or 3.6
Install Package
pip install python_http_client
or
easy_install python_http_client
API Key
Store your SendGrid API key in a .env file
cp .env_sample .env
Edit the .env file and add your API key.
# Quick Start
Here is a quick example:
GET /your/api/{param}/call
import python_http_client
global_headers = {"Authorization": "Basic XXXXXXX"}
client = Client(host='base_url', request_headers=global_headers)
client.your.api._(param).call.get()
print response.status_code
print response.headers
print response.body
POST /your/api/{param}/call with headers, query parameters and a request body with versioning.
import python_http_client
global_headers = {"Authorization": "Basic XXXXXXX"}
client = Client(host='base_url', request_headers=global_headers)
query_params={"hello":0, "world":1}
request_headers={"X-Test": "test"}
data={"some": 1, "awesome": 2, "data": 3}
response = client.your.api._(param).call.post(request_body=data,
query_params=query_params,
request_headers=request_headers)
print response.status_code
print response.headers
print response.body
# Usage
# Roadmap
If you are interested in the future direction of this project, please take a look at our milestones. We would love to hear your feedback.
# How to Contribute
We encourage contribution to our projects, please see our CONTRIBUTING guide for details.
Quick links:
Local Setup of the project
The simplest local development workflow is by using docker.
Steps
Install Docker
Run docker-compose build (This builds the container)
Run docker-compose up (This runs tests by default)
# Troubleshooting
Please see our troubleshooting guide for any issues.
# Announcements
All updates to this project is documented in our CHANGELOG.
# Thanks
We were inspired by the work done on birdy and universalclient.
# About
python-http-client is guided and supported by the SendGrid Developer Experience Team.
python-http-client is maintained and funded by SendGrid, Inc. The names and logos for python-http-client are trademarks of SendGrid, Inc.
# License
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Hashes for python_http_client-3.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 84267d8dcb7bcdf4c5cef321a533cc584c5b52159d4a4d3d4139bfed347b8006 |
|
MD5 | f8bbcf9c0caf1a26eedde014b4b39765 |
|
BLAKE2b-256 | 5c5c9e0cde562757bdb385a3644235e7c4da6f76c8a43d573eb76384ef461d40 |
Hashes for python_http_client-3.1.0-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0a5855902cede46775912d418a23f05fe6f5d60371df1084bef8c219218ce8d9 |
|
MD5 | d2a2b2423419b712a93afea79cd975ad |
|
BLAKE2b-256 | 1ea67c666dd53c6ed124185c9146372534c4f75ebcfa5f716e6fa5bdfb8de900 |