How to Help

Requests is under active development, and contributions are more than welcome!

  1. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug. There is a Contributor Friendly tag for issues that should be ideal for people who are not very familiar with the codebase yet.

  2. Fork the repository on Github to start making your changes to the develop branch (or branch off of it).

  3. Write a test which shows that the bug was fixed or that the feature works as expected.

  4. Send a pull request and bug the maintainer until it gets merged and published. :) Make sure to add yourself to AUTHORS.

Development dependencies

You’ll need to install gunicorn and httpbin and various other dependencies in order to run requests’ test suite:

$ virtualenv env
$ . env/bin/activate
$ make
$ make test

The Makefile has various useful targets for testing. For example, if you want to see how your pull request will behave with Travis-CI you would run make travis.

Versions of Python to Test On

Officially (as of 26-Nov-2012), requests supports python 2.6-3.3. In the future, support for 3.1 and 3.2 may be dropped. In general you will need to test on at least one python 2 and one python 3 version. You can also set up Travis CI for your own fork before you submit a pull request so that you are assured your fork works. To use Travis CI for your fork and other projects see their documentation.

What Needs to be Done

  • Documentation needs a roadmap.