Ngiri (Warhog) Proxy and HTTP client.
Project description
Ngiri - A next-generation HTTP client for Python.
Ngiri is a fully featured Poxy and HTTP client library for Python 3. It includes an integrated command line client, has support for both HTTP/1.1 and HTTP/2, and provides both sync and async APIs.
Install ngiri using pip:
$ pip install ngiri
Now, let's get started:
>>> import ngiri
>>> r = ngiri.get('https://www.example.org/')
>>> r
<Response [200 OK]>
>>> r.status_code
200
>>> r.headers['content-type']
'text/html; charset=UTF-8'
>>> r.text
'<!doctype html>\n<html>\n<head>\n<title>Example Domain</title>...'
Or, using the command-line client.
$ pip install 'ngiri[cli]' # The command line client is an optional dependency.
Which now allows us to use ngiri directly from the command-line...
Sending a request...
Features
ngiri builds on the well-established usability of requests, and gives you:
- A broadly requests-compatible API.
- An integrated command-line client.
- HTTP/1.1 and HTTP/2 support.
- Standard synchronous interface, but with async support if you need it.
- Ability to make requests directly to WSGI applications or ASGI applications.
- Strict timeouts everywhere.
- Fully type annotated.
- 100% test coverage.
Plus all the standard features of requests...
- International Domains and URLs
- Keep-Alive & Connection Pooling
- Sessions with Cookie Persistence
- Browser-style SSL Verification
- Basic/Digest Authentication
- Elegant Key/Value Cookies
- Automatic Decompression
- Automatic Content Decoding
- Unicode Response Bodies
- Multipart File Uploads
- HTTP(S) Proxy Support
- Connection Timeouts
- Streaming Downloads
- .netrc Support
- Chunked Requests
Installation
Install with pip:
$ pip install ngiri
Or, to include the optional HTTP/2 support, use:
$ pip install ngiri[http2]
ngiri requires Python 3.8+.
Documentation
Project documentation is available at https://www.ngiri.co.tz/.
For a run-through of all the basics, head over to the QuickStart.
For more advanced topics, see the Advanced Usage section, the async support section, or the HTTP/2 section.
The Developer Interface provides a comprehensive API reference.
To find out about tools that integrate with ngiri, see Third Party Packages.
Contribute
If you want to contribute with ngiri check out the Contributing Guide to learn how to start.
Dependencies
The ngiri project relies on these excellent libraries:
httpcore- The underlying transport implementation forngiri.h11- HTTP/1.1 support.
certifi- SSL certificates.idna- Internationalized domain name support.sniffio- Async library autodetection.
As well as these optional installs:
h2- HTTP/2 support. (Optional, withngiri[http2])socksio- SOCKS proxy support. (Optional, withngiri[socks])rich- Rich terminal support. (Optional, withngiri[cli])click- Command line client support. (Optional, withngiri[cli])brotliorbrotlicffi- Decoding for "brotli" compressed responses. (Optional, withngiri[brotli])
A huge amount of credit is due to requests for the API layout that
much of this work follows, as well as to urllib3 for plenty of design
inspiration around the lower-level networking details.
Release Information
Added
- The
proxyargument was added. You should use theproxyargument instead of the deprecatedproxies, or usemounts=for more complex configurations. (#2879)
Deprecated
- The
proxiesargument is now deprecated. It will still continue to work, but it will be removed in the future. (#2879)
Fixed
- Fix cases of double escaping of URL path components. Allow / as a safe character in the query portion. (#2990)
- Handle
NO_PROXYenvvar cases when a fully qualified URL is supplied as the value. (#2741) - Allow URLs where username or password contains unescaped '@'. (#2986)
- Ensure ASGI
raw_pathdoes not include URL query component. (#2999) - Ensure
Response.iter_text()cannot yield empty strings. (#2998)
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.
