PycURL – A Python Interface To The cURL library

PycURL is a Python interface to libcurl, the multiprotocol file transfer library. Similarly to the urllib Python module, PycURL can be used to fetch objects identified by a URL from a Python program. Beyond simple fetches however PycURL exposes most of the functionality of libcurl, including:

  • Speed - libcurl is very fast and PycURL, being a thin wrapper above libcurl, is very fast as well. PycURL was benchmarked to be several times faster than Requests.

  • Features including multiple protocol support, SSL, authentication and proxy options. PycURL supports most of libcurl’s callbacks.

  • Multi and share interfaces.

  • Sockets used for network operations, permitting integration of PycURL into the application’s I/O loop (e.g., using Tornado).

PycURL vs Requests

Requests is another popular Python library that is frequently compared to PycURL.

Advantages of PycURL:

  • PycURL can be several times faster than Requests. The performance difference is larger when there are multiple requests performed and connections are reused.

  • PycURL makes it possible to take advantage of I/O multiplexing via the libcurl multi interface.

  • PycURL supports many protocols, not just HTTP.

  • PycURL generally provides more features, for example ability to use several TLS backends, more authentication options, etc.

Advantages of Requests:

  • Requests is written in pure Python and does not require C extensions. As a result, Requests is trivial to install while PycURL’s installation can be complex (though operating system-specific packages, if available, negate this drawback).

  • Requests’ API is generally easier to learn and use than PycURL’s.

About libcurl

  • libcurl is a free and easy-to-use client-side URL transfer library, supporting DICT, FILE, FTP, FTPS, Gopher, HTTP, HTTPS, IMAP, IMAPS, LDAP, LDAPS, POP3, POP3S, RTMP, RTSP, SCP, SFTP, SMTP, SMTPS, Telnet and TFTP. libcurl supports SSL certificates, HTTP POST, HTTP PUT, FTP uploading, HTTP form based upload, proxies, cookies, user+password authentication (Basic, Digest, NTLM, Negotiate, Kerberos4), file transfer resume, http proxy tunneling and more!

  • libcurl is highly portable, it builds and works identically on numerous platforms, including Solaris, NetBSD, FreeBSD, OpenBSD, Darwin, HPUX, IRIX, AIX, Tru64, Linux, UnixWare, HURD, Windows, Amiga, OS/2, BeOs, Mac OS X, Ultrix, QNX, OpenVMS, RISC OS, Novell NetWare, DOS and more…

  • libcurl is free, thread-safe, IPv6 compatible, feature rich, well supported, fast, thoroughly documented and is already used by many known, big and successful companies and numerous applications.

Requirements

  • Python 3.

  • libcurl 7.19.0 or better.

Installation

On Unix, PycURL is easiest to install using your operating system’s package manager. This will also install libcurl and other dependencies as needed.

Installation via easy_install and pip is also supported:

easy_install pycurl
pip install pycurl

If this does not work, please see PycURL Installation.

On Windows, build from source or use a third-party binary package.

Support

For support questions, please use curl-and-python mailing list. Mailing list archives are available for your perusal as well.

Although not an official support venue, Stack Overflow has been popular with PycURL users as well.

Bugs can be reported via GitHub. Please only use GitHub issues when you are certain you have found a bug in PycURL. If you do not have a patch to fix the bug, or at least a specific code fragment in PycURL that you believe is the cause, you should instead post your inquiry to the mailing list.

Documentation Contents

Indices and tables