{"author":"Elmer Thomas","author_email":"help@twilio.com","bugtrack_url":null,"classifiers":["Programming Language :: Python :: 2.7","Programming Language :: Python :: 3","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.4","Programming Language :: Python :: 3.5","Programming Language :: Python :: 3.6","Programming Language :: Python :: 3.7","Programming Language :: Python :: 3.8","Programming Language :: Python :: 3.9"],"description":".. image:: https://github.com/sendgrid/sendgrid-python/raw/HEAD/twilio_sendgrid_logo.png\n :target: https://www.sendgrid.com\n\n|Test and Deploy Badge| |Twitter Follow| |Codecov branch| |Code Climate| |Python Versions| |PyPI Version| |GitHub contributors| |MIT licensed|\n\n**The default branch name for this repository has been changed to `main` as of 07/27/2020.**\n\n**Quickly and easily access any RESTful or RESTful-like API.**\n\nIf you are looking for the Twilio SendGrid API client library, please see `this repo`_.\n\nTable of Contents\n=================\n\n- `Installation <#installation>`__\n- `Quick Start <#quick-start>`__\n- `Usage <#usage>`__\n- `How to Contribute <#how-to-contribute>`__\n- `Local Setup of the Project <#local-setup-of-the-project>`__\n- `Troubleshooting <#troubleshooting>`__\n- `Announcements <#announcements>`__\n- `Thanks <#thanks>`__\n- `About <#about>`__\n- `License <#license>`__\n\nInstallation\n============\n\nPrerequisites\n-------------\n\n- Python version 2.7 or 3.4+\n\nInstall Package\n---------------\n\n.. code:: bash\n\n pip install python_http_client\n\nor\n\n.. code:: bash\n\n easy_install python_http_client\n\nAPI Key\n-------\n\nStore your Twilio SendGrid API key in a ``.env`` file.\n\n.. code:: bash\n\n cp .env_sample .env\n\nEdit the ``.env`` file and add your API key.\n\nQuick Start\n===========\n\nHere is a quick example:\n\n``GET /your/api/{param}/call``\n\n.. code:: python\n\n import python_http_client\n\n global_headers = {\"Authorization\": \"Bearer XXXXXXX\"}\n client = Client(host='base_url', request_headers=global_headers)\n client.your.api._(param).call.get()\n print(response.status_code)\n print(response.headers)\n print(response.body)\n\n``POST /your/api/{param}/call`` with headers, query parameters and a request body with versioning.\n\n.. code:: python\n\n import python_http_client\n\n global_headers = {\"Authorization\": \"Bearer XXXXXXX\"}\n client = Client(host='base_url', request_headers=global_headers)\n query_params = {\"hello\":0, \"world\":1}\n request_headers = {\"X-Test\": \"test\"}\n data = {\"some\": 1, \"awesome\": 2, \"data\": 3}\n response = client.your.api._(param).call.post(request_body=data,\n query_params=query_params,\n request_headers=request_headers)\n print(response.status_code)\n print(response.headers)\n print(response.body)\n\nUsage\n=====\n\n- `Example Code`_\n\nHow to Contribute\n=================\n\nWe encourage contribution to our projects, please see our `CONTRIBUTING`_ guide for details.\n\nQuick links:\n\n- `Feature Request`_\n- `Bug Reports`_\n- `Improvements to the Codebase`_\n- `Review Pull Requests`_\n\nLocal Setup of the Project\n==========================\n\nThe simplest local development workflow is by using docker.\n\n1. Install Docker\n2. Run ``docker-compose build`` (this builds the container)\n3. Run ``docker-compose up`` (this runs tests by default)\n\nTroubleshooting\n===============\n\nPlease see our `troubleshooting guide`_ for any issues.\n\nAnnouncements\n=============\n\nAll updates to this project is documented in our `CHANGELOG`_.\n\nThanks\n======\n\nWe were inspired by the work done on `birdy`_ and `universalclient`_.\n\nAbout\n=====\n\n**python-http-client** is maintained and funded by Twilio SendGrid, Inc.\nThe names and logos for **python-http-client** are trademarks of Twilio SendGrid, Inc.\n\nLicense\n=======\n\n`The MIT License (MIT)`_\n\n.. _this repo: https://github.com/sendgrid/sendgrid-python\n.. _Example Code: https://github.com/sendgrid/python-http-client/tree/HEAD/examples\n.. _CONTRIBUTING: https://github.com/sendgrid/python-http-client/blob/HEAD/CONTRIBUTING.md\n.. _Feature Request: https://github.com/sendgrid/python-http-client/blob/HEAD/CONTRIBUTING.md#feature-request\n.. _Bug Reports: https://github.com/sendgrid/python-http-client/blob/HEAD/CONTRIBUTING.md#submit-a-bug-report\n.. _Improvements to the Codebase: https://github.com/sendgrid/python-http-client/blob/HEAD/CONTRIBUTING.md#improvements-to-the-codebase\n.. _Review Pull Requests: https://github.com/sendgrid/python-http-client/blob/HEAD/CONTRIBUTING.md#code-reviews\n.. _troubleshooting guide: https://github.com/sendgrid/python-http-client/blob/HEAD/TROUBLESHOOTING.md\n.. _CHANGELOG: https://github.com/sendgrid/python-http-client/blob/HEAD/CHANGELOG.md\n.. _birdy: https://github.com/inueni/birdy\n.. _universalclient: https://github.com/dgreisen/universalclient\n.. _The MIT License (MIT): https://github.com/sendgrid/python-http-client/blob/HEAD/LICENSE\n.. _this is an incredible opportunity to join our #DX team: https://sendgrid.com/careers/role/1421152/?gh_jid=1421152\n\n.. |Test and Deploy Badge| image:: https://github.com/sendgrid/python-http-client/actions/workflows/test-and-deploy.yml/badge.svg\n :target: https://github.com/sendgrid/python-http-client/actions/workflows/test-and-deploy.yml\n.. |Twitter Follow| image:: https://img.shields.io/twitter/follow/sendgrid.svg?style=social&label=Follow\n :target: https://twitter.com/sendgrid\n.. |Codecov branch| image:: https://img.shields.io/codecov/c/github/sendgrid/python-http-client/main.svg?style=flat-square&label=Codecov+Coverage\n :target: https://codecov.io/gh/sendgrid/python-http-client\n.. |Code Climate| image:: https://codeclimate.com/github/sendgrid/python-http-client/badges/gpa.svg\n :target: https://codeclimate.com/github/sendgrid/python-http-client\n.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/python-http-client.svg\n :target: https://pypi.org/project/python-http-client\n.. |PyPI Version| image:: https://img.shields.io/pypi/v/python-http-client.svg\n :target: https://pypi.org/project/python-http-client\n.. |GitHub contributors| image:: https://img.shields.io/github/contributors/sendgrid/python-http-client.svg\n :target: https://github.com/sendgrid/python-http-client/graphs/contributors\n.. |MIT licensed| image:: https://img.shields.io/badge/license-MIT-blue.svg\n :target: https://github.com/sendgrid/python-http-client/blob/HEAD/LICENSE\n\n\n","description_content_type":"text/x-rst","docs_url":null,"download_url":"https://github.com/sendgrid/python-http-client/tarball/3.3.7","downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":"https://github.com/sendgrid/python-http-client","keywords":"REST,HTTP,API","license":"MIT","license_expression":null,"license_files":null,"maintainer":"","maintainer_email":"","name":"python-http-client","package_url":"https://pypi.org/project/python-http-client/","platform":null,"project_url":"https://pypi.org/project/python-http-client/","project_urls":{"Download":"https://github.com/sendgrid/python-http-client/tarball/3.3.7","Homepage":"https://github.com/sendgrid/python-http-client"},"provides_extra":null,"release_url":"https://pypi.org/project/python-http-client/3.3.7/","requires_dist":null,"requires_python":">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*","summary":"HTTP REST client, simplified for Python","version":"3.3.7","yanked":false,"yanked_reason":null}

Package search

python-http-client

project_urls

Dependencies

All package metadata

Releases