diff --git a/AUTHORS.md b/AUTHORS.md new file mode 100644 index 00000000..72fc384d --- /dev/null +++ b/AUTHORS.md @@ -0,0 +1,41 @@ +# HTTPie authors + +- [Jakub Roztocil](https://github.com/jakubroztocil) + +## Patches, features, ideas + +[Complete list of contributors on GitHub](https://github.com/httpie/httpie/graphs/contributors) + +- [Cláudia T. Delgado](https://github.com/claudiatd) +- [Hank Gay](https://github.com/gthank) +- [Jake Basile](https://github.com/jakebasile) +- [Vladimir Berkutov](https://github.com/dair-targ) +- [Jakob Kramer](https://github.com/gandaro) +- [Chris Faulkner](https://github.com/faulkner) +- [Alen Mujezinovic](https://github.com/flashingpumpkin) +- [Praful Mathur](https://github.com/tictactix) +- [Marc Abramowitz](https://github.com/msabramo) +- [Ismail Badawi](https://github.com/isbadawi) +- [Laurent Bachelier](https://github.com/laurentb) +- [Isman Firmansyah](https://github.com/iromli) +- [Simon Olofsson](https://github.com/simono) +- [Churkin Oleg](https://github.com/Bahus) +- [Jökull Sólberg Auðunsson](https://github.com/jokull) +- [Matthew M. Boedicker](https://github.com/mmb) +- [marblar](https://github.com/marblar) +- [Tomek Wójcik](https://github.com/tomekwojcik) +- [Davey Shafik](https://github.com/dshafik) +- [cido](https://github.com/cido) +- [Justin Bonnar](https://github.com/jargonjustin) +- [Nathan LaFreniere](https://github.com/nlf) +- [Matthias Lehmann](https://github.com/matleh) +- [Dennis Brakhane](https://github.com/brakhane) +- [Matt Layman](https://github.com/mblayman) +- [Edward Yang](https://github.com/honorabrutroll) +- [Aleksandr Vinokurov](https://github.com/aleksandr-vin) +- [Jeff Byrnes](https://github.com/jeffbyrnes) +- [Denis Belavin](https://github.com/LuckyDenis) +- [Mickaël Schoentgen](https://github.com/BoboTiG) +- [Elena Lape](https://github.com/elenalape) +- [Rohit Sehgal](https://github.com/r0hi7) +- [Bartłomiej Jacak](https://github.com/bartekjacak) diff --git a/AUTHORS.rst b/AUTHORS.rst deleted file mode 100644 index b32563a1..00000000 --- a/AUTHORS.rst +++ /dev/null @@ -1,43 +0,0 @@ -============== -HTTPie authors -============== - -* `Jakub Roztocil `_ - - -Patches and ideas ------------------ - -`Complete list of contributors on GitHub `_ - -* `Cláudia T. Delgado `_ (logo) -* `Hank Gay `_ -* `Jake Basile `_ -* `Vladimir Berkutov `_ -* `Jakob Kramer `_ -* `Chris Faulkner `_ -* `Alen Mujezinovic `_ -* `Praful Mathur `_ -* `Marc Abramowitz `_ -* `Ismail Badawi `_ -* `Laurent Bachelier `_ -* `Isman Firmansyah `_ -* `Simon Olofsson `_ -* `Churkin Oleg `_ -* `Jökull Sólberg Auðunsson `_ -* `Matthew M. Boedicker `_ -* `marblar `_ -* `Tomek Wójcik `_ -* `Davey Shafik `_ -* `cido `_ -* `Justin Bonnar `_ -* `Nathan LaFreniere `_ -* `Matthias Lehmann `_ -* `Dennis Brakhane `_ -* `Matt Layman `_ -* `Edward Yang `_ -* `Aleksandr Vinokurov `_ -* `Jeff Byrnes `_ -* `Denis Belavin `_ -* `Mickaël Schoentgen `_ -* `Rohit Sehgal `_ diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..850784dd --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,367 @@ +# Change Log + +This document records all notable changes to [HTTPie](https://httpie.io). +This project adheres to [Semantic Versioning](https://semver.org/). + +## [2.5.0-dev](https://github.com/httpie/httpie/compare/2.4.0...master) (unreleased) + +- Added `--raw` to allow specifying the raw request body without extra processing as + an alternative to `stdin`. ([#534](https://github.com/httpie/httpie/issues/534)) +- Added support for XML formatting. ([#1129](https://github.com/httpie/httpie/issues/1129)) +- Added internal support for file-like object responses to improve adapter plugin support. ([#1094](https://github.com/httpie/httpie/issues/1094)) +- Fixed `--continue --download` with a single byte to be downloaded left. ([#1032](https://github.com/httpie/httpie/issues/1032)) +- Fixed `--verbose` HTTP 307 redirects with streamed request body. ([#1088](https://github.com/httpie/httpie/issues/1088)) +- Fixed handling of session files with `Cookie:` followed by other headers. ([#1126](https://github.com/httpie/httpie/issues/1126)) + +## [2.4.0](https://github.com/httpie/httpie/compare/2.3.0...2.4.0) (2021-02-06) + +- Added support for `--session` cookie expiration based on `Set-Cookie: max-age=`. ([#1029](https://github.com/httpie/httpie/issues/1029)) +- Show a `--check-status` warning with `--quiet` as well, not only when the output is redirected. ([#1026](https://github.com/httpie/httpie/issues/1026)) +- Fixed upload with `--session` ([#1020](https://github.com/httpie/httpie/issues/1020)). +- Fixed a missing blank line between request and response ([#1006](https://github.com/httpie/httpie/issues/1006)). + +## [2.3.0](https://github.com/httpie/httpie/compare/2.2.0...2.3.0) (2020-10-25) + +- Added support for streamed uploads ([#201](https://github.com/httpie/httpie/issues/201)). +- Added support for multipart upload streaming ([#684](https://github.com/httpie/httpie/issues/684)). +- Added support for body-from-file upload streaming (`http pie.dev/post @file`). +- Added `--chunked` to enable chunked transfer encoding ([#753](https://github.com/httpie/httpie/issues/753)). +- Added `--multipart` to allow `multipart/form-data` encoding for non-file `--form` requests as well. +- Added support for preserving field order in multipart requests ([#903](https://github.com/httpie/httpie/issues/903)). +- Added `--boundary` to allow a custom boundary string for `multipart/form-data` requests. +- Added support for combining cookies specified on the CLI and in a session file ([#932](https://github.com/httpie/httpie/issues/932)). +- Added out of the box SOCKS support with no extra installation ([#904](https://github.com/httpie/httpie/issues/904)). +- Added `--quiet, -q` flag to enforce silent behaviour. +- Fixed the handling of invalid `expires` dates in `Set-Cookie` headers ([#963](https://github.com/httpie/httpie/issues/963)). +- Removed Tox testing entirely ([#943](https://github.com/httpie/httpie/issues/943)). + +## [2.2.0](https://github.com/httpie/httpie/compare/2.1.0...2.2.0) (2020-06-18) + +- Added support for custom content types for uploaded files ([#668](https://github.com/httpie/httpie/issues/668)). +- Added support for `$XDG_CONFIG_HOME` ([#920](https://github.com/httpie/httpie/issues/920)). +- Added support for `Set-Cookie`-triggered cookie expiration ([#853](https://github.com/httpie/httpie/issues/853)). +- Added `--format-options` to allow disabling sorting, etc. ([#128](https://github.com/httpie/httpie/issues/128)) +- Added `--sorted` and `--unsorted` shortcuts for (un)setting all sorting-related `--format-options`. ([#128](https://github.com/httpie/httpie/issues/128)) +- Added `--ciphers` to allow configuring OpenSSL ciphers ([#870](https://github.com/httpie/httpie/issues/870)). +- Added `netrc` support for auth plugins. Enabled for `--auth-type=basic` + and `digest`, 3rd parties may opt in ([#718](https://github.com/httpie/httpie/issues/718), [#719](https://github.com/httpie/httpie/issues/719), [#852](https://github.com/httpie/httpie/issues/852), [#934](https://github.com/httpie/httpie/issues/934)). +- Fixed built-in plugins-related circular imports ([#925](https://github.com/httpie/httpie/issues/925)). + +## [2.1.0](https://github.com/httpie/httpie/compare/2.0.0...2.1.0) (2020-04-18) + +- Added `--path-as-is` to bypass dot segment (`/../` or `/./`) + URL squashing ([#895](https://github.com/httpie/httpie/issues/895)). +- Changed the default `Accept` header value for JSON requests from + `application/json, */*` to `application/json, */*;q=0.5` + to clearly indicate preference ([#488](https://github.com/httpie/httpie/issues/488)). +- Fixed `--form` file upload mixed with redirected `stdin` error handling + ([#840](https://github.com/httpie/httpie/issues/840)). + +## [2.0.0](https://github.com/httpie/httpie/compare/1.0.3...2.0.0) (2020-01-12) + +- Removed Python 2.7 support ([EOL Jan 2020](https://www.python.org/doc/sunset-python-2/). +- Added `--offline` to allow building an HTTP request and printing it but not + actually sending it over the network. +- Replaced the old collect-all-then-process handling of HTTP communication + with one-by-one processing of each HTTP request or response as they become + available. This means that you can see headers immediately, + see what is being sent even if the request fails, etc. +- Removed automatic config file creation to avoid concurrency issues. +- Removed the default 30-second connection `--timeout` limit. +- Removed Python’s default limit of 100 response headers. +- Added `--max-headers` to allow setting the max header limit. +- Added `--compress` to allow request body compression. +- Added `--ignore-netrc` to allow bypassing credentials from `.netrc`. +- Added `https` alias command with `https://` as the default scheme. +- Added `$ALL_PROXY` documentation. +- Added type annotations throughout the codebase. +- Added `tests/` to the PyPi package for the convenience of + downstream package maintainers. +- Fixed an error when `stdin` was a closed fd. +- Improved `--debug` output formatting. + +## [1.0.3](https://github.com/httpie/httpie/compare/1.0.2...1.0.3) (2019-08-26) + +- Fixed CVE-2019-10751 — the way the output filename is generated for + `--download` requests without `--output` resulting in a redirect has + been changed to only consider the initial URL as the base for the generated + filename, and not the final one. This fixes a potential security issue under + the following scenario: + + 1. A `--download` request with no explicit `--output` is made (e.g., + `$ http -d example.org/file.txt`), instructing httpie to + [generate the output filename](https://httpie.org/doc#downloaded-filename) + from the `Content-Disposition` response header, or from the URL if the header + is not provided. + 2. The server handling the request has been modified by an attacker and + instead of the expected response the URL returns a redirect to another + URL, e.g., `attacker.example.org/.bash_profile`, whose response does + not provide a `Content-Disposition` header (i.e., the base for the + generated filename becomes `.bash_profile` instead of `file.txt`). + 3. Your current directory doesn’t already contain `.bash_profile` + (i.e., no unique suffix is added to the generated filename). + 4. You don’t notice the potentially unexpected output filename + as reported by httpie in the console output + (e.g., `Downloading 100.00 B to ".bash_profile"`). + + Reported by Raul Onitza and Giulio Comi. + +## [1.0.2](https://github.com/httpie/httpie/compare/1.0.1...1.0.2) (2018-11-14) + +- Fixed tests for installation with pyOpenSSL. + +## [1.0.1](https://github.com/httpie/httpie/compare/1.0.0...1.0.1) (2018-11-14) + +- Removed external URL calls from tests. + +## [1.0.0](https://github.com/httpie/httpie/compare/0.9.9...1.0.0) (2018-11-02) + +- Added `--style=auto` which follows the terminal ANSI color styles. +- Added support for selecting TLS 1.3 via `--ssl=tls1.3` + (available once implemented in upstream libraries). +- Added `true`/`false` as valid values for `--verify` + (in addition to `yes`/`no`) and the boolean value is case-insensitive. +- Changed the default `--style` from `solarized` to `auto` (on Windows it stays `fruity`). +- Fixed default headers being incorrectly case-sensitive. +- Removed Python 2.6 support. + +## [0.9.9](https://github.com/httpie/httpie/compare/0.9.8...0.9.9) (2016-12-08) + +- Fixed README. + +## [0.9.8](https://github.com/httpie/httpie/compare/0.9.6...0.9.8) (2016-12-08) + +- Extended auth plugin API. +- Added exit status code `7` for plugin errors. +- Added support for `curses`-less Python installations. +- Fixed `REQUEST_ITEM` arg incorrectly being reported as required. +- Improved `CTRL-C` interrupt handling. +- Added the standard exit status code `130` for keyboard interrupts. + +## [0.9.6](https://github.com/httpie/httpie/compare/0.9.4...0.9.6) (2016-08-13) + +- Added Python 3 as a dependency for Homebrew installations + to ensure some of the newer HTTP features work out of the box + for macOS users (starting with HTTPie 0.9.4.). +- Added the ability to unset a request header with `Header:`, and send an + empty value with `Header;`. +- Added `--default-scheme ` to enable things like + `$ alias https='http --default-scheme=https`. +- Added `-I` as a shortcut for `--ignore-stdin`. +- Added fish shell completion (located in `extras/httpie-completion.fish` + in the GitHub repo). +- Updated `requests` to 2.10.0 so that SOCKS support can be added via + `pip install requests[socks]`. +- Changed the default JSON `Accept` header from `application/json` + to `application/json, */*`. +- Changed the pre-processing of request HTTP headers so that any leading + and trailing whitespace is removed. + +## [0.9.4](https://github.com/httpie/httpie/compare/0.9.3...0.9.4) (2016-07-01) + +- Added `Content-Type` of files uploaded in `multipart/form-data` requests +- Added `--ssl=` to specify the desired SSL/TLS protocol version + to use for HTTPS requests. +- Added JSON detection with `--json, -j` to work around incorrect + `Content-Type` +- Added `--all` to show intermediate responses such as redirects (with `--follow`) +- Added `--history-print, -P WHAT` to specify formatting of intermediate responses +- Added `--max-redirects=N` (default 30) +- Added `-A` as short name for `--auth-type` +- Added `-F` as short name for `--follow` +- Removed the `implicit_content_type` config option + (use `"default_options": ["--form"]` instead) +- Redirected `stdout` doesn't trigger an error anymore when `--output FILE` + is set +- Changed the default `--style` back to `solarized` for better support + of light and dark terminals +- Improved `--debug` output +- Fixed `--session` when used with `--download` +- Fixed `--download` to trim too long filenames before saving the file +- Fixed the handling of `Content-Type` with multiple `+subtype` parts +- Removed the XML formatter as the implementation suffered from multiple issues + +## [0.9.3](https://github.com/httpie/httpie/compare/0.9.2...0.9.3) (2016-01-01) + +- Changed the default color `--style` from `solarized` to `monokai` +- Added basic Bash autocomplete support (need to be installed manually) +- Added request details to connection error messages +- Fixed `'requests.packages.urllib3' has no attribute 'disable_warnings'` + errors that occurred in some installations +- Fixed colors and formatting on Windows +- Fixed `--auth` prompt on Windows + +## [0.9.2](https://github.com/httpie/httpie/compare/0.9.1...0.9.2) (2015-02-24) + +- Fixed compatibility with Requests 2.5.1 +- Changed the default JSON `Content-Type` to `application/json` as UTF-8 + is the default JSON encoding + +## [0.9.1](https://github.com/httpie/httpie/compare/0.9.0...0.9.1) (2015-02-07) + +- Added support for Requests transport adapter plugins + (see [httpie-unixsocket](https://github.com/httpie/httpie-unixsocket) + and [httpie-http2](https://github.com/httpie/httpie-http2)) + +## [0.9.0](https://github.com/httpie/httpie/compare/0.8.0...0.9.0) (2015-01-31) + +- Added `--cert` and `--cert-key` parameters to specify a client side + certificate and private key for SSL +- Improved unicode support +- Improved terminal color depth detection via `curses` +- To make it easier to deal with Windows paths in request items, `\` + now only escapes special characters (the ones that are used as key-value + separators by HTTPie) +- Switched from `unittest` to `pytest` +- Added Python `wheel` support +- Various test suite improvements +- Added `CONTRIBUTING` +- Fixed `User-Agent` overwriting when used within a session +- Fixed handling of empty passwords in URL credentials +- Fixed multiple file uploads with the same form field name +- Fixed `--output=/dev/null` on Linux +- Miscellaneous bugfixes + +## [0.8.0](https://github.com/httpie/httpie/compare/0.7.1...0.8.0) (2014-01-25) + +- Added `field=@file.txt` and `field:=@file.json` for embedding + the contents of text and JSON files into request data +- Added curl-style shorthand for localhost +- Fixed request `Host` header value output so that it doesn't contain + credentials, if included in the URL + +## [0.7.1](https://github.com/httpie/httpie/compare/0.6.0...0.7.1) (2013-09-24) + +- Added `--ignore-stdin` +- Added support for auth plugins +- Improved `--help` output +- Improved `Content-Disposition` parsing for `--download` mode +- Update to Requests 2.0.0 + +## [0.6.0](https://github.com/httpie/httpie/compare/0.5.1...0.6.0) (2013-06-03) + +- XML data is now formatted +- `--session` and `--session-read-only` now also accept paths to + session files (eg. `http --session=/tmp/session.json example.org`) + +## [0.5.1](https://github.com/httpie/httpie/compare/0.5.0...0.5.1) (2013-05-13) + +- `Content-*` and `If-*` request headers are not stored in sessions + anymore as they are request-specific + +## [0.5.0](https://github.com/httpie/httpie/compare/0.4.1...0.5.0) (2013-04-27) + +- Added a download mode via `--download` +- Fixes miscellaneous bugs + +## [0.4.1](https://github.com/httpie/httpie/compare/0.4.0...0.4.1) (2013-02-26) + +- Fixed `setup.py` + +## [0.4.0](https://github.com/httpie/httpie/compare/0.3.0...0.4.0) (2013-02-22) + +- Added Python 3.3 compatibility +- Added Requests >= v1.0.4 compatibility +- Added support for credentials in URL +- Added `--no-option` for every `--option` to be config-friendly +- Mutually exclusive arguments can be specified multiple times. The + last value is used + +## [0.3.0](https://github.com/httpie/httpie/compare/0.2.7...0.3.0) (2012-09-21) + +- Allow output redirection on Windows +- Added configuration file +- Added persistent session support +- Renamed `--allow-redirects` to `--follow` +- Improved the usability of `http --help` +- Fixed installation on Windows with Python 3 +- Fixed colorized output on Windows with Python 3 +- CRLF HTTP header field separation in the output +- Added exit status code `2` for timed-out requests +- Added the option to separate colorizing and formatting + (`--pretty=all`, `--pretty=colors` and `--pretty=format`) + `--ugly` has bee removed in favor of `--pretty=none` + +## [0.2.7](https://github.com/httpie/httpie/compare/0.2.5...0.2.7) (2012-08-07) + +- Added compatibility with Requests 0.13.6 +- Added streamed terminal output. `--stream, -S` can be used to enable + streaming also with `--pretty` and to ensure a more frequent output + flushing +- Added support for efficient large file downloads +- Sort headers by name (unless `--pretty=none`) +- Response body is fetched only when needed (e.g., not with `--headers`) +- Improved content type matching +- Updated Solarized color scheme +- Windows: Added `--output FILE` to store output into a file + (piping results in corrupted data on Windows) +- Proper handling of binary requests and responses +- Fixed printing of `multipart/form-data` requests +- Renamed `--traceback` to `--debug` + +## [0.2.6](https://github.com/httpie/httpie/compare/0.2.5...0.2.6) (2012-07-26) + +- The short option for `--headers` is now `-h` (`-t` has been + removed, for usage use `--help`) +- Form data and URL parameters can have multiple fields with the same name + (e.g.,`http -f url a=1 a=2`) +- Added `--check-status` to exit with an error on HTTP 3xx, 4xx and + 5xx (3, 4, and 5, respectively) +- If the output is piped to another program or redirected to a file, + the default behaviour is to only print the response body + (It can still be overwritten via the `--print` flag.) +- Improved highlighting of HTTP headers +- Added query string parameters (`param==value`) +- Added support for terminal colors under Windows + +## [0.2.5](https://github.com/httpie/httpie/compare/0.2.2...0.2.5) (2012-07-17) + +- Unicode characters in prettified JSON now don't get escaped for + improved readability +- --auth now prompts for a password if only a username provided +- Added support for request payloads from a file path with automatic + `Content-Type` (`http URL @/path`) +- Fixed missing query string when displaying the request headers via + `--verbose` +- Fixed Content-Type for requests with no data + +## [0.2.2](https://github.com/httpie/httpie/compare/0.2.1...0.2.2) (2012-06-24) + +- The `METHOD` positional argument can now be omitted (defaults to + `GET`, or to `POST` with data) +- Fixed --verbose --form +- Added support for Tox + +## [0.2.1](https://github.com/httpie/httpie/compare/0.2.0...0.2.1) (2012-06-13) + +- Added compatibility with `requests-0.12.1` +- Dropped custom JSON and HTTP lexers in favor of the ones newly included + in `pygments-1.5` + +## [0.2.0](https://github.com/httpie/httpie/compare/0.1.6...0.2.0) (2012-04-25) + +- Added Python 3 support +- Added the ability to print the HTTP request as well as the response + (see `--print` and `--verbose`) +- Added support for Digest authentication +- Added file upload support + (`http -f POST file_field_name@/path/to/file`) +- Improved syntax highlighting for JSON +- Added support for field name escaping +- Many bug fixes + +## [0.1.6](https://github.com/httpie/httpie/compare/0.1.5...0.1.6) (2012-03-04) + +- Fixed `setup.py` + +## [0.1.5](https://github.com/httpie/httpie/compare/0.1.4...0.1.5) (2012-03-04) + +- Many improvements and bug fixes + +## [0.1.4](https://github.com/httpie/httpie/compare/b966efa...0.1.4) (2012-02-28) + +- Many improvements and bug fixes + +## [0.1.0](https://github.com/httpie/httpie/commit/b966efa) (2012-02-25) + +- Initial public release diff --git a/CHANGELOG.rst b/CHANGELOG.rst deleted file mode 100644 index d99e5f00..00000000 --- a/CHANGELOG.rst +++ /dev/null @@ -1,511 +0,0 @@ -========== -Change Log -========== - -This document records all notable changes to `HTTPie `_. -This project adheres to `Semantic Versioning `_. - - - -`2.5.0-dev`_ (unreleased) -------------------------- -* Added ``--raw`` to allow specifying the raw request body without extra processing as - an alternative to ``stdin``. (`#534`_) -* Added support for XML formatting. (`#1129`_) -* Added internal support for file-like object responses to improve adapter plugin support. (`#1094`_) -* Fixed ``--continue --download`` with a single byte to be downloaded left. (`#1032`_) -* Fixed ``--verbose`` HTTP 307 redirects with streamed request body. (`#1088`_) -* Fixed handling of session files with ``Cookie:`` followed by other headers. (`#1126`_) - - -`2.4.0`_ (2021-02-06) ---------------------- -* Added support for ``--session`` cookie expiration based on ``Set-Cookie: max-age=``. (`#1029`_) -* Show a ``--check-status`` warning with ``--quiet`` as well, not only when the output is redirected. (`#1026`_) -* Fixed upload with ``--session`` (`#1020`_). -* Fixed a missing blank line between request and response (`#1006`_). - - -`2.3.0`_ (2020-10-25) -------------------------- - -* Added support for streamed uploads (`#201`_). -* Added support for multipart upload streaming (`#684`_). -* Added support for body-from-file upload streaming (``http pie.dev/post @file``). -* Added ``--chunked`` to enable chunked transfer encoding (`#753`_). -* Added ``--multipart`` to allow ``multipart/form-data`` encoding for non-file ``--form`` requests as well. -* Added support for preserving field order in multipart requests (`#903`_). -* Added ``--boundary`` to allow a custom boundary string for ``multipart/form-data`` requests. -* Added support for combining cookies specified on the CLI and in a session file (`#932`_). -* Added out of the box SOCKS support with no extra installation (`#904`_). -* Added ``--quiet, -q`` flag to enforce silent behaviour. -* Fixed the handling of invalid ``expires`` dates in ``Set-Cookie`` headers (`#963`_). -* Removed Tox testing entirely (`#943`_). - - -`2.2.0`_ (2020-06-18) -------------------------- - -* Added support for custom content types for uploaded files (`#668`_). -* Added support for ``$XDG_CONFIG_HOME`` (`#920`_). -* Added support for ``Set-Cookie``-triggered cookie expiration (`#853`_). -* Added ``--format-options`` to allow disabling sorting, etc. (`#128`_) -* Added ``--sorted`` and ``--unsorted`` shortcuts for (un)setting all sorting-related ``--format-options``. (`#128`_) -* Added ``--ciphers`` to allow configuring OpenSSL ciphers (`#870`_). -* Added ``netrc`` support for auth plugins. Enabled for ``--auth-type=basic`` - and ``digest``, 3rd parties may opt in (`#718`_, `#719`_, `#852`_, `#934`_). -* Fixed built-in plugins-related circular imports (`#925`_). - - -`2.1.0`_ (2020-04-18) ---------------------- - -* Added ``--path-as-is`` to bypass dot segment (``/../`` or ``/./``) - URL squashing (`#895`_). -* Changed the default ``Accept`` header value for JSON requests from - ``application/json, */*`` to ``application/json, */*;q=0.5`` - to clearly indicate preference (`#488`_). -* Fixed ``--form`` file upload mixed with redirected ``stdin`` error handling - (`#840`_). - - -`2.0.0`_ (2020-01-12) -------------------------- -* Removed Python 2.7 support (`EOL Jan 2020 `_). -* Added ``--offline`` to allow building an HTTP request and printing it but not - actually sending it over the network. -* Replaced the old collect-all-then-process handling of HTTP communication - with one-by-one processing of each HTTP request or response as they become - available. This means that you can see headers immediately, - see what is being sent even if the request fails, etc. -* Removed automatic config file creation to avoid concurrency issues. -* Removed the default 30-second connection ``--timeout`` limit. -* Removed Python’s default limit of 100 response headers. -* Added ``--max-headers`` to allow setting the max header limit. -* Added ``--compress`` to allow request body compression. -* Added ``--ignore-netrc`` to allow bypassing credentials from ``.netrc``. -* Added ``https`` alias command with ``https://`` as the default scheme. -* Added ``$ALL_PROXY`` documentation. -* Added type annotations throughout the codebase. -* Added ``tests/`` to the PyPi package for the convenience of - downstream package maintainers. -* Fixed an error when ``stdin`` was a closed fd. -* Improved ``--debug`` output formatting. - - -`1.0.3`_ (2019-08-26) ---------------------- - -* Fixed CVE-2019-10751 — the way the output filename is generated for - ``--download`` requests without ``--output`` resulting in a redirect has - been changed to only consider the initial URL as the base for the generated - filename, and not the final one. This fixes a potential security issue under - the following scenario: - - 1. A ``--download`` request with no explicit ``--output`` is made (e.g., - ``$ http -d example.org/file.txt``), instructing httpie to - `generate the output filename `_ - from the ``Content-Disposition`` response header, or from the URL if the header - is not provided. - 2. The server handling the request has been modified by an attacker and - instead of the expected response the URL returns a redirect to another - URL, e.g., ``attacker.example.org/.bash_profile``, whose response does - not provide a ``Content-Disposition`` header (i.e., the base for the - generated filename becomes ``.bash_profile`` instead of ``file.txt``). - 3. Your current directory doesn’t already contain ``.bash_profile`` - (i.e., no unique suffix is added to the generated filename). - 4. You don’t notice the potentially unexpected output filename - as reported by httpie in the console output - (e.g., ``Downloading 100.00 B to ".bash_profile"``). - - Reported by Raul Onitza and Giulio Comi. - - -`1.0.2`_ (2018-11-14) -------------------------- - -* Fixed tests for installation with pyOpenSSL. - - -`1.0.1`_ (2018-11-14) -------------------------- - -* Removed external URL calls from tests. - - -`1.0.0`_ (2018-11-02) -------------------------- - -* Added ``--style=auto`` which follows the terminal ANSI color styles. -* Added support for selecting TLS 1.3 via ``--ssl=tls1.3`` - (available once implemented in upstream libraries). -* Added ``true``/``false`` as valid values for ``--verify`` - (in addition to ``yes``/``no``) and the boolean value is case-insensitive. -* Changed the default ``--style`` from ``solarized`` to ``auto`` (on Windows it stays ``fruity``). -* Fixed default headers being incorrectly case-sensitive. -* Removed Python 2.6 support. - - - -`0.9.9`_ (2016-12-08) ---------------------- - -* Fixed README. - - -`0.9.8`_ (2016-12-08) ---------------------- - -* Extended auth plugin API. -* Added exit status code ``7`` for plugin errors. -* Added support for ``curses``-less Python installations. -* Fixed ``REQUEST_ITEM`` arg incorrectly being reported as required. -* Improved ``CTRL-C`` interrupt handling. -* Added the standard exit status code ``130`` for keyboard interrupts. - - -`0.9.6`_ (2016-08-13) ---------------------- - -* Added Python 3 as a dependency for Homebrew installations - to ensure some of the newer HTTP features work out of the box - for macOS users (starting with HTTPie 0.9.4.). -* Added the ability to unset a request header with ``Header:``, and send an - empty value with ``Header;``. -* Added ``--default-scheme `` to enable things like - ``$ alias https='http --default-scheme=https``. -* Added ``-I`` as a shortcut for ``--ignore-stdin``. -* Added fish shell completion (located in ``extras/httpie-completion.fish`` - in the GitHub repo). -* Updated ``requests`` to 2.10.0 so that SOCKS support can be added via - ``python -m pip install requests[socks]``. -* Changed the default JSON ``Accept`` header from ``application/json`` - to ``application/json, */*``. -* Changed the pre-processing of request HTTP headers so that any leading - and trailing whitespace is removed. - - -`0.9.4`_ (2016-07-01) ---------------------- - -* Added ``Content-Type`` of files uploaded in ``multipart/form-data`` requests -* Added ``--ssl=`` to specify the desired SSL/TLS protocol version - to use for HTTPS requests. -* Added JSON detection with ``--json, -j`` to work around incorrect - ``Content-Type`` -* Added ``--all`` to show intermediate responses such as redirects (with ``--follow``) -* Added ``--history-print, -P WHAT`` to specify formatting of intermediate responses -* Added ``--max-redirects=N`` (default 30) -* Added ``-A`` as short name for ``--auth-type`` -* Added ``-F`` as short name for ``--follow`` -* Removed the ``implicit_content_type`` config option - (use ``"default_options": ["--form"]`` instead) -* Redirected ``stdout`` doesn't trigger an error anymore when ``--output FILE`` - is set -* Changed the default ``--style`` back to ``solarized`` for better support - of light and dark terminals -* Improved ``--debug`` output -* Fixed ``--session`` when used with ``--download`` -* Fixed ``--download`` to trim too long filenames before saving the file -* Fixed the handling of ``Content-Type`` with multiple ``+subtype`` parts -* Removed the XML formatter as the implementation suffered from multiple issues - - - -`0.9.3`_ (2016-01-01) ---------------------- - -* Changed the default color ``--style`` from ``solarized`` to ``monokai`` -* Added basic Bash autocomplete support (need to be installed manually) -* Added request details to connection error messages -* Fixed ``'requests.packages.urllib3' has no attribute 'disable_warnings'`` - errors that occurred in some installations -* Fixed colors and formatting on Windows -* Fixed ``--auth`` prompt on Windows - - -`0.9.2`_ (2015-02-24) ---------------------- - -* Fixed compatibility with Requests 2.5.1 -* Changed the default JSON ``Content-Type`` to ``application/json`` as UTF-8 - is the default JSON encoding - - -`0.9.1`_ (2015-02-07) ---------------------- - -* Added support for Requests transport adapter plugins - (see `httpie-unixsocket `_ - and `httpie-http2 `_) - - -`0.9.0`_ (2015-01-31) ---------------------- - -* Added ``--cert`` and ``--cert-key`` parameters to specify a client side - certificate and private key for SSL -* Improved unicode support -* Improved terminal color depth detection via ``curses`` -* To make it easier to deal with Windows paths in request items, ``\`` - now only escapes special characters (the ones that are used as key-value - separators by HTTPie) -* Switched from ``unittest`` to ``pytest`` -* Added Python `wheel` support -* Various test suite improvements -* Added ``CONTRIBUTING`` -* Fixed ``User-Agent`` overwriting when used within a session -* Fixed handling of empty passwords in URL credentials -* Fixed multiple file uploads with the same form field name -* Fixed ``--output=/dev/null`` on Linux -* Miscellaneous bugfixes - - -`0.8.0`_ (2014-01-25) ---------------------- - -* Added ``field=@file.txt`` and ``field:=@file.json`` for embedding - the contents of text and JSON files into request data -* Added curl-style shorthand for localhost -* Fixed request ``Host`` header value output so that it doesn't contain - credentials, if included in the URL - - -`0.7.1`_ (2013-09-24) ---------------------- - -* Added ``--ignore-stdin`` -* Added support for auth plugins -* Improved ``--help`` output -* Improved ``Content-Disposition`` parsing for ``--download`` mode -* Update to Requests 2.0.0 - - -`0.6.0`_ (2013-06-03) ---------------------- - -* XML data is now formatted -* ``--session`` and ``--session-read-only`` now also accept paths to - session files (e.g. ``http --session=/tmp/session.json example.org``) - - -`0.5.1`_ (2013-05-13) ---------------------- - -* ``Content-*`` and ``If-*`` request headers are not stored in sessions - anymore as they are request-specific - - -`0.5.0`_ (2013-04-27) ---------------------- - -* Added a download mode via ``--download`` -* Fixes miscellaneous bugs - - -`0.4.1`_ (2013-02-26) ---------------------- - -* Fixed ``setup.py`` - - -`0.4.0`_ (2013-02-22) ---------------------- - -* Added Python 3.3 compatibility -* Added Requests >= v1.0.4 compatibility -* Added support for credentials in URL -* Added ``--no-option`` for every ``--option`` to be config-friendly -* Mutually exclusive arguments can be specified multiple times. The - last value is used - - -`0.3.0`_ (2012-09-21) ---------------------- - -* Allow output redirection on Windows -* Added configuration file -* Added persistent session support -* Renamed ``--allow-redirects`` to ``--follow`` -* Improved the usability of ``http --help`` -* Fixed installation on Windows with Python 3 -* Fixed colorized output on Windows with Python 3 -* CRLF HTTP header field separation in the output -* Added exit status code ``2`` for timed-out requests -* Added the option to separate colorizing and formatting - (``--pretty=all``, ``--pretty=colors`` and ``--pretty=format``) - ``--ugly`` has bee removed in favor of ``--pretty=none`` - - -`0.2.7`_ (2012-08-07) ---------------------- - -* Added compatibility with Requests 0.13.6 -* Added streamed terminal output. ``--stream, -S`` can be used to enable - streaming also with ``--pretty`` and to ensure a more frequent output - flushing -* Added support for efficient large file downloads -* Sort headers by name (unless ``--pretty=none``) -* Response body is fetched only when needed (e.g., not with ``--headers``) -* Improved content type matching -* Updated Solarized color scheme -* Windows: Added ``--output FILE`` to store output into a file - (piping results in corrupted data on Windows) -* Proper handling of binary requests and responses -* Fixed printing of ``multipart/form-data`` requests -* Renamed ``--traceback`` to ``--debug`` - - -`0.2.6`_ (2012-07-26) ---------------------- - -* The short option for ``--headers`` is now ``-h`` (``-t`` has been - removed, for usage use ``--help``) -* Form data and URL parameters can have multiple fields with the same name - (e.g.,``http -f url a=1 a=2``) -* Added ``--check-status`` to exit with an error on HTTP 3xx, 4xx and - 5xx (3, 4, and 5, respectively) -* If the output is piped to another program or redirected to a file, - the default behaviour is to only print the response body - (It can still be overwritten via the ``--print`` flag.) -* Improved highlighting of HTTP headers -* Added query string parameters (``param==value``) -* Added support for terminal colors under Windows - - -`0.2.5`_ (2012-07-17) ---------------------- - -* Unicode characters in prettified JSON now don't get escaped for - improved readability -* --auth now prompts for a password if only a username provided -* Added support for request payloads from a file path with automatic - ``Content-Type`` (``http URL @/path``) -* Fixed missing query string when displaying the request headers via - ``--verbose`` -* Fixed Content-Type for requests with no data - - -`0.2.2`_ (2012-06-24) ---------------------- - -* The ``METHOD`` positional argument can now be omitted (defaults to - ``GET``, or to ``POST`` with data) -* Fixed --verbose --form -* Added support for Tox - - -`0.2.1`_ (2012-06-13) ---------------------- - -* Added compatibility with ``requests-0.12.1`` -* Dropped custom JSON and HTTP lexers in favor of the ones newly included - in ``pygments-1.5`` - - -`0.2.0`_ (2012-04-25) ---------------------- - -* Added Python 3 support -* Added the ability to print the HTTP request as well as the response - (see ``--print`` and ``--verbose``) -* Added support for Digest authentication -* Added file upload support - (``http -f POST file_field_name@/path/to/file``) -* Improved syntax highlighting for JSON -* Added support for field name escaping -* Many bug fixes - - -`0.1.6`_ (2012-03-04) ---------------------- - -* Fixed ``setup.py`` - - -`0.1.5`_ (2012-03-04) ---------------------- - -* Many improvements and bug fixes - - -`0.1.4`_ (2012-02-28) ---------------------- - -* Many improvements and bug fixes - - -`0.1.0`_ (2012-02-25) ---------------------- - -* Initial public release - - -.. _`0.1.0`: https://github.com/httpie/httpie/commit/b966efa -.. _0.1.4: https://github.com/httpie/httpie/compare/b966efa...0.1.4 -.. _0.1.5: https://github.com/httpie/httpie/compare/0.1.4...0.1.5 -.. _0.1.6: https://github.com/httpie/httpie/compare/0.1.5...0.1.6 -.. _0.2.0: https://github.com/httpie/httpie/compare/0.1.6...0.2.0 -.. _0.2.1: https://github.com/httpie/httpie/compare/0.2.0...0.2.1 -.. _0.2.2: https://github.com/httpie/httpie/compare/0.2.1...0.2.2 -.. _0.2.5: https://github.com/httpie/httpie/compare/0.2.2...0.2.5 -.. _0.2.6: https://github.com/httpie/httpie/compare/0.2.5...0.2.6 -.. _0.2.7: https://github.com/httpie/httpie/compare/0.2.5...0.2.7 -.. _0.3.0: https://github.com/httpie/httpie/compare/0.2.7...0.3.0 -.. _0.4.0: https://github.com/httpie/httpie/compare/0.3.0...0.4.0 -.. _0.4.1: https://github.com/httpie/httpie/compare/0.4.0...0.4.1 -.. _0.5.0: https://github.com/httpie/httpie/compare/0.4.1...0.5.0 -.. _0.5.1: https://github.com/httpie/httpie/compare/0.5.0...0.5.1 -.. _0.6.0: https://github.com/httpie/httpie/compare/0.5.1...0.6.0 -.. _0.7.1: https://github.com/httpie/httpie/compare/0.6.0...0.7.1 -.. _0.8.0: https://github.com/httpie/httpie/compare/0.7.1...0.8.0 -.. _0.9.0: https://github.com/httpie/httpie/compare/0.8.0...0.9.0 -.. _0.9.1: https://github.com/httpie/httpie/compare/0.9.0...0.9.1 -.. _0.9.2: https://github.com/httpie/httpie/compare/0.9.1...0.9.2 -.. _0.9.3: https://github.com/httpie/httpie/compare/0.9.2...0.9.3 -.. _0.9.4: https://github.com/httpie/httpie/compare/0.9.3...0.9.4 -.. _0.9.6: https://github.com/httpie/httpie/compare/0.9.4...0.9.6 -.. _0.9.8: https://github.com/httpie/httpie/compare/0.9.6...0.9.8 -.. _0.9.9: https://github.com/httpie/httpie/compare/0.9.8...0.9.9 -.. _1.0.0: https://github.com/httpie/httpie/compare/0.9.9...1.0.0 -.. _1.0.1: https://github.com/httpie/httpie/compare/1.0.0...1.0.1 -.. _1.0.2: https://github.com/httpie/httpie/compare/1.0.1...1.0.2 -.. _1.0.3: https://github.com/httpie/httpie/compare/1.0.2...1.0.3 -.. _2.0.0: https://github.com/httpie/httpie/compare/1.0.3...2.0.0 -.. _2.1.0: https://github.com/httpie/httpie/compare/2.0.0...2.1.0 -.. _2.2.0: https://github.com/httpie/httpie/compare/2.1.0...2.2.0 -.. _2.3.0: https://github.com/httpie/httpie/compare/2.2.0...2.3.0 -.. _2.4.0: https://github.com/httpie/httpie/compare/2.3.0...2.4.0 -.. _2.5.0-dev: https://github.com/httpie/httpie/compare/2.4.0...master - -.. _#128: https://github.com/httpie/httpie/issues/128 -.. _#201: https://github.com/httpie/httpie/issues/201 -.. _#488: https://github.com/httpie/httpie/issues/488 -.. _#534: https://github.com/httpie/httpie/issues/534 -.. _#668: https://github.com/httpie/httpie/issues/668 -.. _#684: https://github.com/httpie/httpie/issues/684 -.. _#718: https://github.com/httpie/httpie/issues/718 -.. _#719: https://github.com/httpie/httpie/issues/719 -.. _#753: https://github.com/httpie/httpie/issues/753 -.. _#840: https://github.com/httpie/httpie/issues/840 -.. _#853: https://github.com/httpie/httpie/issues/853 -.. _#852: https://github.com/httpie/httpie/issues/852 -.. _#870: https://github.com/httpie/httpie/issues/870 -.. _#895: https://github.com/httpie/httpie/issues/895 -.. _#903: https://github.com/httpie/httpie/issues/903 -.. _#920: https://github.com/httpie/httpie/issues/920 -.. _#904: https://github.com/httpie/httpie/issues/904 -.. _#925: https://github.com/httpie/httpie/issues/925 -.. _#932: https://github.com/httpie/httpie/issues/932 -.. _#934: https://github.com/httpie/httpie/issues/934 -.. _#943: https://github.com/httpie/httpie/issues/943 -.. _#963: https://github.com/httpie/httpie/issues/963 -.. _#1006: https://github.com/httpie/httpie/issues/1006 -.. _#1020: https://github.com/httpie/httpie/issues/1020 -.. _#1026: https://github.com/httpie/httpie/issues/1026 -.. _#1029: https://github.com/httpie/httpie/issues/1029 -.. _#1032: https://github.com/httpie/httpie/issues/1032 -.. _#1088: https://github.com/httpie/httpie/issues/1088 -.. _#1094: https://github.com/httpie/httpie/issues/1094 -.. _#1126: https://github.com/httpie/httpie/issues/1126 -.. _#1129: https://github.com/httpie/httpie/issues/1129 diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 2bc4be37..156e1740 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -14,22 +14,22 @@ appearance, race, religion, or sexual identity and orientation. Examples of behavior that contributes to creating a positive environment include: -* Using welcoming and inclusive language -* Being respectful of differing viewpoints and experiences -* Gracefully accepting constructive criticism -* Focusing on what is best for the community -* Showing empathy towards other community members +- Using welcoming and inclusive language +- Being respectful of differing viewpoints and experiences +- Gracefully accepting constructive criticism +- Focusing on what is best for the community +- Showing empathy towards other community members Examples of unacceptable behavior by participants include: -* The use of sexualized language or imagery and unwelcome sexual attention or - advances -* Trolling, insulting/derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or electronic - address, without explicit permission -* Other conduct which could reasonably be considered inappropriate in a - professional setting +- The use of sexualized language or imagery and unwelcome sexual attention or + advances +- Trolling, insulting/derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or electronic + address, without explicit permission +- Other conduct which could reasonably be considered inappropriate in a + professional setting ## Our Responsibilities @@ -67,10 +67,8 @@ members of the project's leadership. ## Attribution -This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, -available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html - -[homepage]: https://www.contributor-covenant.org +This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), +version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..76a82062 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,196 @@ +# Contributing to HTTPie + +Bug reports and code and documentation patches are welcome. You can +help this project also by using the development version of HTTPie +and by reporting any bugs you might encounter. + +## 1. Reporting bugs + +**It's important that you provide the full command argument list +as well as the output of the failing command.** + +Use the `--debug` flag and copy&paste both the command and its output +to your bug report, e.g.: + +```bash +$ http --debug + +``` + +## 2. Contributing Code and Docs + +Before working on a new feature or a bug, please browse [existing issues](https://github.com/httpie/httpie/issues) +to see whether it has previously been discussed. + +If your change alters HTTPie’s behaviour or interface, it's a good idea to +discuss it before you start working on it. + +If you are fixing an issue, the first step should be to create a test case that +reproduces the incorrect behaviour. That will also help you to build an +understanding of the issue at hand. + +**Pull requests introducing code changes without tests +will generally not get merged. The same goes for PRs changing HTTPie’s +behaviour and not providing documentation.** + +Conversely, PRs consisting of documentation improvements or tests +for existing-yet-previously-untested behavior will very likely be merged. +Therefore, docs and tests improvements are a great candidate for your first +contribution. + +Consider also adding a [CHANGELOG](https://github.com/httpie/httpie/blob/master/CHANGELOG.md) entry for your changes. + +### Development Environment + +#### Getting the code + +Go to https://github.com/httpie/httpie and fork the project repository. + +```bash +# Clone your fork +$ git clone git@github.com:/httpie.git + +# Enter the project directory +$ cd httpie + +# Create a branch for your changes +$ git checkout -b my_topical_branch +``` + +#### Setup + +The [Makefile](https://github.com/httpie/httpie/blob/master/Makefile) contains a bunch of tasks to get you started. Just run +the following command, which: + +- Creates an isolated Python virtual environment inside `./venv` + (via the standard library [venv](https://docs.python.org/3/library/venv.html) tool); +- installs all dependencies and also installs HTTPie + (in editable mode so that the `http` command will point to your + working copy). +- and runs tests (It is the same as running `make install test`). + +```bash +$ make +``` + +#### Python virtual environment + +Activate the Python virtual environment—created via the `make install` +task during [setup](#setup) for your active shell session using the following command: + +```bash +$ source venv/bin/activate +``` + +(If you use `virtualenvwrapper`, you can also use `workon httpie` to +activate the environment — we have created a symlink for you. It’s a bit of +a hack but it works™.) + +You should now see `(httpie)` next to your shell prompt, and +the `http` command should point to your development copy: + +``` +(httpie) ~/Code/httpie $ which http +/Users//Code/httpie/venv/bin/http +(httpie) ~/Code/httpie $ http --version +2.0.0-dev +``` + +(Btw, you don’t need to activate the virtual environment if you just want +run some of the `make` tasks. You can also invoke the development +version of HTTPie directly with `./venv/bin/http` without having to activate +the environment first. The same goes for `./venv/bin/pytest`, etc.). + +### Making Changes + +Please make sure your changes conform to [Style Guide for Python Code](https://python.org/dev/peps/pep-0008/) (PEP8) +and that `make pycodestyle` passes. + +### Testing & CI + +Please add tests for any new features and bug fixes. + +When you open a Pull Request, [GitHub Actions](https://github.com/httpie/httpie/actions) will automatically run HTTPie’s [test suite](https://github.com/httpie/httpie/tree/master/tests) against your code, so please make sure all checks pass. + +#### Running tests locally + +HTTPie uses the [pytest](https://pytest.org/) runner. + +```bash +# Run tests on the current Python interpreter with coverage. +$ make test + +# Run tests with coverage +$ make test-cover + +# Test PEP8 compliance +$ make codestyle + +# Run extended tests — for code as well as .md files syntax, packaging, etc. +$ make test-all +``` + +#### Running specific tests + +After you have activated your virtual environment (see [setup](#setup)), you +can run specific tests from the terminal: + +```bash +# Run specific tests on the current Python +$ python -m pytest tests/test_uploads.py +$ python -m pytest tests/test_uploads.py::TestMultipartFormDataFileUpload +$ python -m pytest tests/test_uploads.py::TestMultipartFormDataFileUpload::test_upload_ok +``` + +See [Makefile](https://github.com/httpie/httpie/blob/master/Makefile) for additional development utilities. + +#### Windows + +If you are on a Windows machine and not able to run `make`, +follow the next steps for a basic setup. As a prerequisite, you need to have +Python 3.6+ installed. + +Create a virtual environment and activate it: + +```powershell +C:\> python -m venv --prompt httpie venv +C:\> venv\Scripts\activate +``` + +Install HTTPie in editable mode with all the dependencies: + +```powershell +C:\> python -m pip install --upgrade -e . -r requirements-dev.txt +``` + +You should now see `(httpie)` next to your shell prompt, and +the `http` command should point to your development copy: + +```powershell +# In PowerShell: +(httpie) PS C:\Users\ovezovs\httpie> Get-Command http +CommandType Name Version Source +----------- ---- ------- ------ +Application http.exe 0.0.0.0 C:\Users\ovezovs\httpie\venv\Scripts\http.exe +``` + +```bash +# In CMD: +(httpie) C:\Users\ovezovs\httpie> where http +C:\Users\ovezovs\httpie\venv\Scripts\http.exe +C:\Users\ovezovs\AppData\Local\Programs\Python\Python38-32\Scripts\http.exe + +(httpie) C:\Users\ovezovs\httpie> http --version +2.3.0-dev +``` + +Use `pytest` to run tests locally with an active virtual environment: + +```bash +# Run all tests +$ python -m pytest +``` + +______________________________________________________________________ + +Finally, feel free to add yourself to [AUTHORS](https://github.com/httpie/httpie/blob/master/AUTHORS.md)! diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst deleted file mode 100644 index d1ad30ce..00000000 --- a/CONTRIBUTING.rst +++ /dev/null @@ -1,239 +0,0 @@ -###################### -Contributing to HTTPie -###################### - -Bug reports and code and documentation patches are welcome. You can -help this project also by using the development version of HTTPie -and by reporting any bugs you might encounter. - -1. Reporting bugs -================= - -**It's important that you provide the full command argument list -as well as the output of the failing command.** -Use the ``--debug`` flag and copy&paste both the command and its output -to your bug report, e.g.: - -.. code-block:: bash - - $ http --debug - - - - -2. Contributing Code and Docs -============================= - -Before working on a new feature or a bug, please browse `existing issues`_ -to see whether it has previously been discussed. - -If your change alters HTTPie’s behaviour or interface, it's a good idea to -discuss it before you start working on it. - -If you are fixing an issue, the first step should be to create a test case that -reproduces the incorrect behaviour. That will also help you to build an -understanding of the issue at hand. - -**Pull requests introducing code changes without tests -will generally not get merged. The same goes for PRs changing HTTPie’s -behaviour and not providing documentation.** - -Conversely, PRs consisting of documentation improvements or tests -for existing-yet-previously-untested behavior will very likely be merged. -Therefore, docs and tests improvements are a great candidate for your first -contribution. - -Consider also adding a ``CHANGELOG`` entry for your changes. - - -Development Environment --------------------------------- - - -Getting the code -**************** - -Go to https://github.com/httpie/httpie and fork the project repository. - - -.. code-block:: bash - - # Clone your fork - git clone git@github.com:/httpie.git - - # Enter the project directory - cd httpie - - # Create a branch for your changes - git checkout -b my_topical_branch - - -Setup -***** - -The `Makefile`_ contains a bunch of tasks to get you started. Just run -the following command, which: - - -* Creates an isolated Python virtual environment inside ``./venv`` - (via the standard library `venv`_ tool); -* installs all dependencies and also installs HTTPie - (in editable mode so that the ``http`` command will point to your - working copy). -* and runs tests (It is the same as running ``make install test``). - - -.. code-block:: bash - - make - - - -Python virtual environment -************************** - -Activate the Python virtual environment—created via the ``make install`` -task during `setup`_—for your active shell session using the following command: - -.. code-block:: bash - - source venv/bin/activate - -(If you use ``virtualenvwrapper``, you can also use ``workon httpie`` to -activate the environment — we have created a symlink for you. It’s a bit of -a hack but it works™.) - -You should now see ``(httpie)`` next to your shell prompt, and -the ``http`` command should point to your development copy: - -.. code-block:: - - (httpie) ~/Code/httpie $ which http - /Users/jakub/Code/httpie/venv/bin/http - (httpie) ~/Code/httpie $ http --version - 2.0.0-dev - -(Btw, you don’t need to activate the virtual environment if you just want -run some of the ``make`` tasks. You can also invoke the development -version of HTTPie directly with ``./venv/bin/http`` without having to activate -the environment first. The same goes for ``./venv/bin/pytest``, etc.). - - -Making Changes --------------- - -Please make sure your changes conform to `Style Guide for Python Code`_ (PEP8) -and that ``make codestyle`` passes. - - -Testing & CI ------------- - -Please add tests for any new features and bug fixes. - -When you open a pull request, -`GitHub Actions `_ -will automatically run HTTPie’s `test suite`_ against your code -so please make sure all checks pass. - - -Running tests locally -********************* - -HTTPie uses the `pytest`_ runner. - - -.. code-block:: bash - - # Run tests on the current Python interpreter with coverage. - make test - - # Run tests with coverage - make test-cover - - # Test PEP8 compliance - make codestyle - - # Run extended tests — for code as well as .rst files syntax, packaging, etc. - make test-all - - -Running specific tests -********************** - -After you have activated your virtual environment (see `setup`_), you -can run specific tests from the terminal: - -.. code-block:: bash - - # Run specific tests on the current Python - python -m pytest tests/test_uploads.py - python -m pytest tests/test_uploads.py::TestMultipartFormDataFileUpload - python -m pytest tests/test_uploads.py::TestMultipartFormDataFileUpload::test_upload_ok - ------ - -See `Makefile`_ for additional development utilities. - -Windows -******* - -If you are on a Windows machine and not able to run ``make``, -follow the next steps for a basic setup. As a prerequisite, you need to have -Python 3.6+ installed. - -Create a virtual environment and activate it: - -.. code-block:: powershell - - python -m venv --prompt httpie venv - venv\Scripts\activate - -Install HTTPie in editable mode with all the dependencies: - -.. code-block:: powershell - - python -m pip install --upgrade --editable '.[dev]' - -You should now see ``(httpie)`` next to your shell prompt, and -the ``http`` command should point to your development copy: - -.. code-block:: powershell - - # In PowerShell: - (httpie) PS C:\Users\ovezovs\httpie> Get-Command http - CommandType Name Version Source - ----------- ---- ------- ------ - Application http.exe 0.0.0.0 C:\Users\ovezovs\httpie\venv\Scripts\http.exe - -.. code-block:: bash - - # In CMD: - (httpie) C:\Users\ovezovs\httpie> where http - C:\Users\ovezovs\httpie\venv\Scripts\http.exe - C:\Users\ovezovs\AppData\Local\Programs\Python\Python38-32\Scripts\http.exe - - (httpie) C:\Users\ovezovs\httpie> http --version - 2.3.0-dev - -Use ``pytest`` to run tests locally with an active virtual environment: - -.. code-block:: bash - - # Run all tests - python -m pytest - - ------ - - -Finally, feel free to add yourself to `AUTHORS`_! - - -.. _existing issues: https://github.com/httpie/httpie/issues?state=open -.. _AUTHORS: https://github.com/httpie/httpie/blob/master/AUTHORS.rst -.. _Makefile: https://github.com/httpie/httpie/blob/master/Makefile -.. _venv: https://docs.python.org/3/library/venv.html -.. _pytest: https://pytest.org/ -.. _Style Guide for Python Code: https://python.org/dev/peps/pep-0008/ -.. _test suite: https://github.com/httpie/httpie/tree/master/tests diff --git a/MANIFEST.in b/MANIFEST.in index b58818e6..e166aa09 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,7 +1,8 @@ include LICENSE -include README.rst -include CHANGELOG.rst -include AUTHORS.rst +include README.md +include CHANGELOG.md +include AUTHORS.md +include docs/README.md # recursive-include tests/ * diff --git a/Makefile b/Makefile index cc4deff2..fa15e8fa 100644 --- a/Makefile +++ b/Makefile @@ -1,5 +1,5 @@ ############################################################################### -# See ./CONTRIBUTING.rst +# See ./CONTRIBUTING.md ############################################################################### .PHONY: build @@ -174,20 +174,6 @@ uninstall-httpie: @echo -############################################################################### -# Docs -############################################################################### - -pdf: - @echo "Converting README.rst to PDF…" - rst2pdf \ - --strip-elements-with-class=no-pdf \ - README.rst \ - -o README.pdf - @echo "Done" - @echo - - ############################################################################### # Homebrew ############################################################################### diff --git a/README.md b/README.md new file mode 100644 index 00000000..ecad3a36 --- /dev/null +++ b/README.md @@ -0,0 +1,105 @@ +
+ + Httpie-Logo-Lockup-Pink@2x + + +# HTTPie: the human-friendly HTTP CLI client for working with APIs + + + +[![Build](https://img.shields.io/github/workflow/status/httpie/httpie/Build?color=%2373DC8C&label=Build&logo=github)](https://github.com/httpie/httpie/actions) +[![Latest version](https://img.shields.io/pypi/v/httpie.svg?style=flat&label=Latest%20stable%20version&color=%23FA9BFA&logo=pypi&logoColor=white)](https://pypi.python.org/pypi/httpie) +[![Coverage](https://img.shields.io/codecov/c/github/httpie/httpie?style=flat&label=Coverage&color=%237D7D7D&logo=codecov)](https://codecov.io/gh/httpie/httpie) +[![Downloads](https://img.shields.io/pypi/dm/httpie?color=%23DBDE52&label=Downloads&logo=python)](https://pepy.tech/project/httpie) + +[![Issues](https://img.shields.io/github/issues/httpie/httpie?style=flat&color=%23FFA24E&label=Issues&logo=github)](https://github.com/httpie/httpie/issues) +[![Docs](https://img.shields.io/badge/stable%20docs-httpie.org%2Fdocs-brightgreen?style=flat&color=%234B78E6&label=Stable%20docs)](https://httpie.org/docs) +[![Chat](https://img.shields.io/badge/chat-on%20Discord-brightgreen?style=flat&logo=discord&label=Chat%20on&color=%23B464F0)](https://httpie.io/chat) + +HTTPie (pronounced _aitch-tee-tee-pie_ 🥧) is a command-line HTTP client. + +The `http` and `https` commands let you send arbitrary HTTP requests for testing, debugging, and generally interacting with APIs & HTTP servers. Commands use simple, natural syntax and provide a formatted and colorized output. + +**Visit [httpie.io](https://httpie.io) to learn more** + +## Features + +- Simple syntax +- Formatted and colorized terminal output +- Built-in JSON support +- Forms and file uploads +- HTTPS, proxies, and authentication +- Persistent sessions +- Wget-like downloads +- Linux, macOS and Windows support +- Plugins, such as JWTAuth and OAuth + +See the [complete list of features](https://httpie.io/docs). + +## Documentation + +Full documentation and installation guides live in [httpie.io/docs](https://httpie.io/docs). + +## Installation + +HTTPie can be installed using Homebrew on macOS (`brew install httpie`), and `pip` on Linux, Windows and other Operating Systems (e.g. `python -m pip install --upgrade httpie`). + +See the [docs](https://httpie.io/docs) for system requirements and full installation instructions. + +## Examples + +Hello World: + +``` +$ https httpie.io/hello +``` + +Custom [HTTP method](https://httpie.io/docs#http-method), [HTTP headers](https://httpie.io/docs#http-headers) and [JSON](https://httpie.io/docs#json) data: + +``` +$ http PUT pie.dev/put X-API-Token:123 name=John +``` + +Build and print a request without sending it using [offline mode](https://httpie.io/docs#offline-mode): + +``` +$ http --offline pie.dev/post hello=offline +``` + +Use [GitHub API](https://developer.github.com/v3/issues/comments/#create-a-comment) to post a comment on an [Issue](https://github.com/httpie/httpie/issues/83) with [authentication](https://httpie.io/docs#authentication): + +``` +$ http -a USERNAME POST https://api.github.com/repos/httpie/httpie/issues/83/comments body='HTTPie is awesome! :heart:' +``` + +**See [the documentation](https://httpie.io/docs) for a complete list of examples and use cases.** + +## Contributing + +We :sparkling_heart: our contributors! Please read the [contribution guide](https://github.com/httpie/httpie/blob/master/CONTRIBUTING.md) for how to contribute. +Have a look through existing [Issues](https://github.com/httpie/httpie/issues) and [Pull Requests](https://github.com/httpie/httpie/pulls) that you could help with. + +[![Issues](https://img.shields.io/github/issues/httpie/httpie?style=flat&color=%23FFA24E&label=Issues&logo=github)](https://github.com/httpie/httpie/issues) +[![PRs](https://img.shields.io/github/issues-pr/httpie/httpie?color=%23FA9BFA&label=Pull%20Requests&logo=github)](https://github.com/httpie/httpie/pulls) + +If you'd like to request a feature or report a bug, please [create a GitHub Issue](https://github.com/httpie/httpie/issues) using one of the templates provided. + +## Community & Support + +- Visit the [HTTPie website](https://httpie.io) for full documentation and useful links. + +- Join our [Discord server](https://httpie.io/chat) is to ask questions, discuss features, and for general API chat. + +- Tweet at [@httpie](https://twitter.com/httpie) on Twitter. + +- Use [StackOverflow](https://stackoverflow.com/questions/tagged/httpie) to ask questions and include a `httpie` tag. + +- Create [GitHub Issues](https://github.com/httpie/httpie/issues) for bug reports and feature requests. + +- Subscribe to the [HTTPie newsletter](https://httpie.io) for occasional updates. + +## License + +[![License](https://img.shields.io/github/license/httpie/httpie?color=%2373DC8C&label=License)](https://github.com/httpie/httpie/blob/master/LICENSE) + +HTTPie is licensed under the [BSD-3-Clause License](https://github.com/httpie/httpie/blob/master/LICENSE). diff --git a/README.rst b/README.rst deleted file mode 100644 index f8c6a27a..00000000 --- a/README.rst +++ /dev/null @@ -1,2269 +0,0 @@ -HTTPie: human-friendly CLI HTTP client for the API era -###################################################### - -HTTPie (pronounced *aitch-tee-tee-pie*) is a command-line HTTP client. -Its goal is to make CLI interaction with web services as human-friendly as possible. -HTTPie is designed for testing, debugging, and generally interacting with APIs & HTTP servers. -The ``http`` & ``https`` commands allow for creating and sending arbitrary HTTP requests. -They use simple and natural syntax and provide formatted and colorized output. - - - -.. class:: no-web no-pdf - - |docs| |pypi| |build| |coverage| |downloads| |gitter| - - -.. class:: no-web no-pdf - - .. image:: https://raw.githubusercontent.com/httpie/httpie/master/httpie.gif - :alt: HTTPie in action - :width: 100% - :align: center - - -.. contents:: - -.. section-numbering:: - - -About this document -=================== - -This documentation is best viewed at `httpie.org/docs `_. - -You can select your corresponding HTTPie version as well as run examples directly from the -browser using a `termible.io `_ embedded terminal. - -If you are reading this on GitHub, then this text covers the current *development* version. -You are invited to submit fixes and improvements to the docs by editing -`README.rst `_. - - -Main features -============= - -* Expressive and intuitive syntax -* Formatted and colorized terminal output -* Built-in JSON support -* Forms and file uploads -* HTTPS, proxies, and authentication -* Arbitrary request data -* Custom headers -* Persistent sessions -* Wget-like downloads -* Linux, macOS and Windows support -* Plugins -* Documentation -* Test coverage - - -.. class:: no-web - - .. image:: https://raw.githubusercontent.com/httpie/httpie/master/httpie.png - :alt: HTTPie compared to cURL - :width: 100% - :align: center - - -Installation -============ - - -macOS ------ - - -On macOS, HTTPie can be installed via `Homebrew `_ -(recommended): - -.. code-block:: bash - - $ brew install httpie - - -A MacPorts *port* is also available: - -.. code-block:: bash - - $ port install httpie - -Linux ------ - -Most Linux distributions provide a package that can be installed using the -system package manager, for example: - -.. code-block:: bash - - # Debian, Ubuntu, etc. - $ apt install httpie - -.. code-block:: bash - - # Fedora - $ dnf install httpie - -.. code-block:: bash - - # CentOS, RHEL, ... - $ yum install httpie - -.. code-block:: bash - - # Gentoo - $ emerge httpie - -.. code-block:: bash - - # Arch Linux - $ pacman -S httpie - -.. code-block:: bash - - # Solus - $ eopkg install httpie - - -Windows, etc. -------------- - -A universal installation method (that works on Windows, macOS, Linux, …, -and always provides the latest version) is to use `pip`_: - -.. code-block:: bash - - # Make sure we have an up-to-date version of pip and setuptools: - $ python -m pip install --upgrade pip setuptools - - $ python -m pip install --upgrade httpie - - -(If ``pip`` installation fails for some reason, you can try -``easy_install httpie`` as a fallback.) - -Windows users can also install HTTPie with `Chocolatey `_: - -.. code-block:: bash - - $ choco upgrade httpie - - -Python version --------------- - -Python version 3.6 or greater is required. - - -Unstable version ----------------- - -You can also install the latest unreleased development version directly from -the ``master`` branch on GitHub. It is a work-in-progress of a future stable -release so the experience might be not as smooth. - - -.. class:: no-pdf - -|build| - - -On macOS you can install it with Homebrew: - -.. code-block:: bash - - $ brew uninstall --force httpie - $ brew install --HEAD httpie - - -Otherwise with ``pip``: - -.. code-block:: bash - - $ python -m pip install --upgrade https://github.com/httpie/httpie/archive/master.tar.gz - - -Verify that now we have the -`current development version identifier `_ -with the ``-dev`` suffix, for example: - -.. code-block:: bash - - $ http --version - # 2.0.0-dev - - -Usage -===== - - -Hello World: - - -.. code-block:: bash - - $ https httpie.io/hello - - -Synopsis: - -.. code-block:: bash - - $ http [flags] [METHOD] URL [ITEM [ITEM]] - - -See also ``http --help``. - - -Examples --------- - -Custom `HTTP method`_, `HTTP headers`_ and `JSON`_ data: - -.. code-block:: bash - - $ http PUT pie.dev/put X-API-Token:123 name=John - - -Submitting `forms`_: - -.. code-block:: bash - - $ http -f POST pie.dev/post hello=World - - -See the request that is being sent using one of the `output options`_: - -.. code-block:: bash - - $ http -v pie.dev/get - - -Build and print a request without sending it using `offline mode`_: - -.. code-block:: bash - - $ http --offline pie.dev/post hello=offline - - -Use `GitHub API`_ to post a comment on an -`issue `_ -with `authentication`_: - -.. code-block:: bash - - $ http -a USERNAME POST https://api.github.com/repos/httpie/httpie/issues/83/comments body='HTTPie is awesome! :heart:' - - -Upload a file using `redirected input`_: - -.. code-block:: bash - - $ http pie.dev/post < files/data.json - - -Download a file and save it via `redirected output`_: - -.. code-block:: bash - - $ http pie.dev/image/png > image.png - - -Download a file ``wget`` style: - -.. code-block:: bash - - $ http --download pie.dev/image/png - -Use named `sessions`_ to make certain aspects of the communication persistent -between requests to the same host: - - -.. code-block:: bash - - $ http --session=logged-in -a username:password pie.dev/get API-Key:123 - - -.. code-block:: bash - - $ http --session=logged-in pie.dev/headers - - -Set a custom ``Host`` header to work around missing DNS records: - -.. code-block:: bash - - $ http localhost:8000 Host:example.com - -.. - - -HTTP method -=========== - -The name of the HTTP method comes right before the URL argument: - -.. code-block:: bash - - $ http DELETE pie.dev/delete - - -Which looks similar to the actual ``Request-Line`` that is sent: - -.. code-block:: http - - DELETE /delete HTTP/1.1 - - -When the ``METHOD`` argument is omitted from the command, HTTPie defaults to -either ``GET`` (with no request data) or ``POST`` (with request data). - - -Request URL -=========== - -The only information HTTPie needs to perform a request is a URL. - -The default scheme is ``http://`` and can be omitted from the argument: - -.. code-block:: bash - - $ http example.org - # => http://example.org - - -HTTPie also installs an ``https`` executable, where the default -scheme is ``https://``: - - -.. code-block:: bash - - $ https example.org - # => https://example.org - - -Querystring parameters ----------------------- - -If you find yourself manually constructing URLs with querystring parameters -on the terminal, you may appreciate the ``param==value`` syntax for appending -URL parameters. - -With that, you don’t have to worry about escaping the ``&`` -separators for your shell. Additionally, any special characters in the -parameter name or value get automatically URL-escaped -(as opposed to parameters specified in the full URL, which HTTPie doesn’t -modify). - -.. code-block:: bash - - $ http https://api.github.com/search/repositories q==httpie per_page==1 - - -.. code-block:: http - - GET /search/repositories?q=httpie&per_page=1 HTTP/1.1 - - - -URL shortcuts for ``localhost`` -------------------------------- - -Additionally, curl-like shorthand for localhost is supported. -This means that, for example ``:3000`` would expand to ``http://localhost:3000`` -If the port is omitted, then port 80 is assumed. - -.. code-block:: bash - - $ http :/foo - - -.. code-block:: http - - GET /foo HTTP/1.1 - Host: localhost - - -.. code-block:: bash - - $ http :3000/bar - - -.. code-block:: http - - GET /bar HTTP/1.1 - Host: localhost:3000 - - -.. code-block:: bash - - $ http : - - -.. code-block:: http - - GET / HTTP/1.1 - Host: localhost - - -Other default schemes ---------------------- - -When HTTPie is invoked as ``https`` then the default scheme is ``https://`` -(``$ https example.org`` will make a request to ``https://example.org``). - -You can also use the ``--default-scheme `` option to create -shortcuts for other protocols than HTTP (possibly supported via plugins). -Example for the `httpie-unixsocket `_ plugin: - -.. code-block:: bash - - # Before - $ http http+unix://%2Fvar%2Frun%2Fdocker.sock/info - - -.. code-block:: bash - - # Create an alias - $ alias http-unix='http --default-scheme="http+unix"' - - -.. code-block:: bash - - # Now the scheme can be omitted - $ http-unix %2Fvar%2Frun%2Fdocker.sock/info - - -``--path-as-is`` ----------------- - -The standard behaviour of HTTP clients is to normalize the path portion of URLs by squashing dot segments -as a typically filesystem would: - - -.. code-block:: bash - - $ http -v example.org/./../../etc/password - -.. code-block:: http - - GET /etc/password HTTP/1.1 - - -The ``--path-as-is`` option allows you to disable this behavior: - -.. code-block:: bash - - $ http --path-as-is -v example.org/./../../etc/password - -.. code-block:: http - - GET /../../etc/password HTTP/1.1 - - -Request items -============= - -There are a few different *request item* types that provide a -convenient mechanism for specifying HTTP headers, simple JSON and -form data, files, and URL parameters. - -They are key/value pairs specified after the URL. All have in -common that they become part of the actual request that is sent and that -their type is distinguished only by the separator used: -``:``, ``=``, ``:=``, ``==``, ``@``, ``=@``, and ``:=@``. The ones with an -``@`` expect a file path as value. - -+------------------------------+---------------------------------------------------+ -| Item Type | Description | -+==============================+===================================================+ -| HTTP Headers | Arbitrary HTTP header, e.g. ``X-API-Token:123``. | -| ``Name:Value`` | | -+------------------------------+---------------------------------------------------+ -| URL parameters | Appends the given name/value pair as a query | -| ``name==value`` | string parameter to the URL. | -| | The ``==`` separator is used. | -+------------------------------+---------------------------------------------------+ -| Data Fields | Request data fields to be serialized as a JSON | -| ``field=value``, | object (default), to be form-encoded | -| ``field=@file.txt`` | (with ``--form, -f``), or to be serialized as | -| | ``multipart/form-data`` (with ``--multipart``). | -+------------------------------+---------------------------------------------------+ -| Raw JSON fields | Useful when sending JSON and one or | -| ``field:=json``, | more fields need to be a ``Boolean``, ``Number``, | -| ``field:=@file.json`` | nested ``Object``, or an ``Array``, e.g., | -| | ``meals:='["ham","spam"]'`` or ``pies:=[1,2,3]`` | -| | (note the quotes). | -+------------------------------+---------------------------------------------------+ -| Fields upload fields | Only available with ``--form, -f`` and | -| ``field@/dir/file`` | ``--multipart``. | -| ``field@file;type=mime`` | For example ``screenshot@~/Pictures/img.png``, or | -| | ``'cv@cv.txt;type=text/markdown'``. | -| | With ``--form``, the presence of a file field | -| | results in a ``--multipart`` request. | -+------------------------------+---------------------------------------------------+ - - -Note that the structured data fields aren’t the only way to specify request data: -The `raw request body`_ section describes mechanisms for passing arbitrary request data. - - -Escaping rules --------------- - -You can use ``\`` to escape characters that shouldn’t be used as separators -(or parts thereof). For instance, ``foo\==bar`` will become a data key/value -pair (``foo=`` and ``bar``) instead of a URL parameter. - -Often it is necessary to quote the values, e.g. ``foo='bar baz'``. - -If any of the field names or headers starts with a minus -(e.g., ``-fieldname``), you need to place all such items after the special -token ``--`` to prevent confusion with ``--arguments``: - -.. code-block:: bash - - $ http pie.dev/post -- -name-starting-with-dash=foo -Unusual-Header:bar - -.. code-block:: http - - POST /post HTTP/1.1 - -Unusual-Header: bar - Content-Type: application/json - - { - "-name-starting-with-dash": "foo" - } - - - -JSON -==== - -JSON is the *lingua franca* of modern web services and it is also the -**implicit content type** HTTPie uses by default. - - -Simple example: - -.. code-block:: bash - - $ http PUT pie.dev/put name=John email=john@example.org - -.. code-block:: http - - PUT / HTTP/1.1 - Accept: application/json, */*;q=0.5 - Accept-Encoding: gzip, deflate - Content-Type: application/json - Host: pie.dev - - { - "name": "John", - "email": "john@example.org" - } - - -Default behaviour ------------------ - - -If your command includes some data `request items`_, they are serialized as a JSON -object by default. HTTPie also automatically sets the following headers, -both of which can be overwritten: - -================ ======================================= -``Content-Type`` ``application/json`` -``Accept`` ``application/json, */*;q=0.5`` -================ ======================================= - - -Explicit JSON -------------- - -You can use ``--json, -j`` to explicitly set ``Accept`` -to ``application/json`` regardless of whether you are sending data -(it’s a shortcut for setting the header via the usual header notation: -``http url Accept:'application/json, */*;q=0.5'``). Additionally, -HTTPie will try to detect JSON responses even when the -``Content-Type`` is incorrectly ``text/plain`` or unknown. - - - -Non-string JSON fields ----------------------- - -Non-string JSON fields use the ``:=`` separator, which allows you to embed arbitrary JSON data -into the resulting JSON object. Additionally, text and raw JSON files can also be embedded into -fields using ``=@`` and ``:=@``: - -.. code-block:: bash - - $ http PUT pie.dev/put \ - name=John \ # String (default) - age:=29 \ # Raw JSON — Number - married:=false \ # Raw JSON — Boolean - hobbies:='["http", "pies"]' \ # Raw JSON — Array - favorite:='{"tool": "HTTPie"}' \ # Raw JSON — Object - bookmarks:=@files/data.json \ # Embed JSON file - description=@files/text.txt # Embed text file - - -.. code-block:: http - - PUT /person/1 HTTP/1.1 - Accept: application/json, */*;q=0.5 - Content-Type: application/json - Host: pie.dev - - { - "age": 29, - "hobbies": [ - "http", - "pies" - ], - "description": "John is a nice guy who likes pies.", - "married": false, - "name": "John", - "favorite": { - "tool": "HTTPie" - }, - "bookmarks": { - "HTTPie": "https://httpie.org", - } - } - - -Raw and complex JSON --------------------- - -Please note that with the structured `request items`_ data field syntax, commands -can quickly become unwieldy when sending complex structures. -In such cases, it’s better to pass the full raw JSON data as a `raw request body`_, for example: - -.. code-block:: bash - - $ echo -n '{"hello": "world"}' | http POST pie.dev/post - -.. code-block:: bash - - $ http --raw '{"hello": "world"}' POST pie.dev/post - -.. code-block:: bash - - $ http POST pie.dev/post < files/data.json - -Furthermore, the structure syntax only allows you to send an object as the JSON document, but not an array, etc. -Here, again, the solution is to use a `raw request body`_. - -Forms -===== - -Submitting forms is very similar to sending `JSON`_ requests. Often the only -difference is in adding the ``--form, -f`` option, which ensures that -data fields are serialized as, and ``Content-Type`` is set to, -``application/x-www-form-urlencoded; charset=utf-8``. It is possible to make -form data the implicit content type instead of JSON -via the `config`_ file. - - -Regular forms -------------- - -.. code-block:: bash - - $ http --form POST pie.dev/post name='John Smith' - - -.. code-block:: http - - POST /post HTTP/1.1 - Content-Type: application/x-www-form-urlencoded; charset=utf-8 - - name=John+Smith - - -File upload forms ------------------ - -If one or more file fields is present, the serialization and content type is -``multipart/form-data``: - -.. code-block:: bash - - $ http -f POST pie.dev/post name='John Smith' cv@~/files/data.xml - - -The request above is the same as if the following HTML form were -submitted: - -.. code-block:: html - -
- - -
- -Please note that ``@`` is used to simulate a file upload form field, whereas -``=@`` just embeds the file content as a regular text field value. - -When uploading files, their content type is inferred from the file name. You can manually -override the inferred content type: - -.. code-block:: bash - - $ http -f POST pie.dev/post name='John Smith' cv@'~/files/data.bin;type=application/pdf' - -To perform a ``multipart/form-data`` request even without any files, use -``--multipart`` instead of ``--form``: - -.. code-block:: bash - - $ http --multipart --offline example.org hello=world - -.. code-block:: http - - POST / HTTP/1.1 - Content-Length: 129 - Content-Type: multipart/form-data; boundary=c31279ab254f40aeb06df32b433cbccb - Host: example.org - - --c31279ab254f40aeb06df32b433cbccb - Content-Disposition: form-data; name="hello" - - world - --c31279ab254f40aeb06df32b433cbccb-- - -File uploads are always streamed to avoid memory issues with large files. - -By default, HTTPie uses a random unique string as the multipart boundary -but you can use ``--boundary`` to specify a custom string instead: - -.. code-block:: bash - - $ http --form --multipart --boundary=xoxo --offline example.org hello=world - -.. code-block:: http - - POST / HTTP/1.1 - Content-Length: 129 - Content-Type: multipart/form-data; boundary=xoxo - Host: example.org - - --xoxo - Content-Disposition: form-data; name="hello" - - world - --xoxo-- - -If you specify a custom ``Content-Type`` header without including the boundary -bit, HTTPie will add the boundary value (explicitly specified or auto-generated) -to the header automatically: - - -.. code-block:: bash - - http --form --multipart --offline example.org hello=world Content-Type:multipart/letter - -.. code-block:: http - - POST / HTTP/1.1 - Content-Length: 129 - Content-Type: multipart/letter; boundary=c31279ab254f40aeb06df32b433cbccb - Host: example.org - - --c31279ab254f40aeb06df32b433cbccb - Content-Disposition: form-data; name="hello" - - world - --c31279ab254f40aeb06df32b433cbccb-- - - -HTTP headers -============ - -To set custom headers you can use the ``Header:Value`` notation: - -.. code-block:: bash - - $ http pie.dev/headers User-Agent:Bacon/1.0 'Cookie:valued-visitor=yes;foo=bar' \ - X-Foo:Bar Referer:https://httpie.org/ - - -.. code-block:: http - - GET /headers HTTP/1.1 - Accept: */* - Accept-Encoding: gzip, deflate - Cookie: valued-visitor=yes;foo=bar - Host: pie.dev - Referer: https://httpie.org/ - User-Agent: Bacon/1.0 - X-Foo: Bar - - -Default request headers ------------------------ - -There are a couple of default headers that HTTPie sets: - -.. code-block:: http - - GET / HTTP/1.1 - Accept: */* - Accept-Encoding: gzip, deflate - User-Agent: HTTPie/ - Host: - - - -Any of these can be overwritten and some of them unset (see below). - - - -Empty headers and header un-setting ------------------------------------ - -To unset a previously specified header -(such a one of the default headers), use ``Header:``: - - -.. code-block:: bash - - $ http pie.dev/headers Accept: User-Agent: - - -To send a header with an empty value, use ``Header;``: - - -.. code-block:: bash - - $ http pie.dev/headers 'Header;' - - -Limiting response headers -------------------------- - -The ``--max-headers=n`` options allows you to control the number of headers -HTTPie reads before giving up (the default ``0``, i.e., there’s no limit). - - -.. code-block:: bash - - $ http --max-headers=100 pie.dev/get - - - -Offline mode -============ - -Use ``--offline`` to construct HTTP requests without sending them anywhere. -With ``--offline``, HTTPie builds a request based on the specified options and arguments, prints it to ``stdout``, -and then exits. It works completely offline; no network connection is ever made. -This has a number of use cases, including: - - -Generating API documentation examples that you can copy & paste without sending a request: - - -.. code-block:: bash - - $ http --offline POST server.chess/api/games API-Key:ZZZ w=magnus b=hikaru t=180 i=2 - - -.. code-block:: bash - - $ http --offline MOVE server.chess/api/games/123 API-Key:ZZZ p=b a=R1a3 t=77 - - -Generating raw requests that can be sent with any other client: - -.. code-block:: bash - - # 1. save a raw request to a file: - $ http --offline POST pie.dev/post hello=world > request.http - - -.. code-block:: bash - - # 2. send it over the wire with, for example, the fantastic netcat tool: - $ nc pie.dev 80 < request.http - - -You can also use the ``--offline`` mode for debugging and exploring HTTP and HTTPie, and for “dry runs”. - -``--offline`` has the side-effect of automatically activating ``--print=HB``, i.e., both the request headers and the body -are printed. You can customize the output with the usual `output options`_, with the exception that there -is not response to be printed. You can use ``--offline`` in combination with all the other options (e.g., ``--session``). - - - -Cookies -======= - -HTTP clients send cookies to the server as regular `HTTP headers`_. That means, -HTTPie does not offer any special syntax for specifying cookies — the usual -``Header:Value`` notation is used: - - -Send a single cookie: - -.. code-block:: bash - - $ http pie.dev/cookies Cookie:sessionid=foo - -.. code-block:: http - - GET / HTTP/1.1 - Accept: */* - Accept-Encoding: gzip, deflate - Connection: keep-alive - Cookie: sessionid=foo - Host: pie.dev - User-Agent: HTTPie/0.9.9 - - -Send multiple cookies -(note the header is quoted to prevent the shell from interpreting the ``;``): - -.. code-block:: bash - - $ http pie.dev/cookies 'Cookie:sessionid=foo;another-cookie=bar' - -.. code-block:: http - - GET / HTTP/1.1 - Accept: */* - Accept-Encoding: gzip, deflate - Connection: keep-alive - Cookie: sessionid=foo;another-cookie=bar - Host: pie.dev - User-Agent: HTTPie/0.9.9 - - -If you often deal with cookies in your requests, then chances are you’d appreciate -the `sessions`_ feature. - - -Authentication -============== - -The currently supported authentication schemes are Basic and Digest -(see `auth plugins`_ for more). There are two flags that control authentication: - -=================== ====================================================== -``--auth, -a`` Pass a ``username:password`` pair as - the argument. Or, if you only specify a username - (``-a username``), you’ll be prompted for - the password before the request is sent. - To send an empty password, pass ``username:``. - The ``username:password@hostname`` URL syntax is - supported as well (but credentials passed via ``-a`` - have higher priority). - -``--auth-type, -A`` Specify the auth mechanism. Possible values are - ``basic``, ``digest``, or the name of any `auth plugins`_ you have installed. The default value is - ``basic`` so it can often be omitted. -=================== ====================================================== - - - -Basic auth ----------- - - -.. code-block:: bash - - $ http -a username:password pie.dev/basic-auth/username/password - - -Digest auth ------------ - - -.. code-block:: bash - - $ http -A digest -a username:password pie.dev/digest-auth/httpie/username/password - - -Password prompt ---------------- - -.. code-block:: bash - - $ http -a username pie.dev/basic-auth/username/password - - -Empty password --------------- - -.. code-block:: bash - - $ http -a username: pie.dev/headers - - -``.netrc`` ----------- - -Authentication information from your ``~/.netrc`` -file is by default honored as well. - -For example: - -.. code-block:: bash - - $ cat ~/.netrc - machine pie.dev - login httpie - password test - -.. code-block:: bash - - $ http pie.dev/basic-auth/httpie/test - HTTP/1.1 200 OK - [...] - -This can be disabled with the ``--ignore-netrc`` option: - -.. code-block:: bash - - $ http --ignore-netrc pie.dev/basic-auth/httpie/test - HTTP/1.1 401 UNAUTHORIZED - [...] - - -Auth plugins ------------- - -Additional authentication mechanism can be installed as plugins. -They can be found on the `Python Package Index `_. -Here’s a few picks: - -* `httpie-api-auth `_: ApiAuth -* `httpie-aws-auth `_: AWS / Amazon S3 -* `httpie-edgegrid `_: EdgeGrid -* `httpie-hmac-auth `_: HMAC -* `httpie-jwt-auth `_: JWTAuth (JSON Web Tokens) -* `httpie-negotiate `_: SPNEGO (GSS Negotiate) -* `httpie-ntlm `_: NTLM (NT LAN Manager) -* `httpie-oauth `_: OAuth -* `requests-hawk `_: Hawk - - - - -HTTP redirects -============== - -By default, HTTP redirects are not followed and only the first -response is shown: - - -.. code-block:: bash - - $ http pie.dev/redirect/3 - - -Follow ``Location`` -------------------- - -To instruct HTTPie to follow the ``Location`` header of ``30x`` responses -and show the final response instead, use the ``--follow, -F`` option: - - -.. code-block:: bash - - $ http --follow pie.dev/redirect/3 - - -With ``307 Temporary Redirect`` and ``308 Permanent Redirect``, the method and the body of the original request -are reused to perform the redirected request. Otherwise, a body-less ``GET`` request is performed. - - -Showing intermediary redirect responses ---------------------------------------- - -If you additionally wish to see the intermediary requests/responses, -then use the ``--all`` option as well: - - -.. code-block:: bash - - $ http --follow --all pie.dev/redirect/3 - - - -Limiting maximum redirects followed ------------------------------------ - -To change the default limit of maximum ``30`` redirects, use the -``--max-redirects=`` option: - - -.. code-block:: bash - - $ http --follow --all --max-redirects=2 pie.dev/redirect/3 - - -Proxies -======= - -You can specify proxies to be used through the ``--proxy`` argument for each -protocol (which is included in the value in case of redirects across protocols): - -.. code-block:: bash - - $ http --proxy=http:http://10.10.1.10:3128 --proxy=https:https://10.10.1.10:1080 example.org - - -With Basic authentication: - -.. code-block:: bash - - $ http --proxy=http:http://user:pass@10.10.1.10:3128 example.org - - -Environment variables ---------------------- - -You can also configure proxies by environment variables ``ALL_PROXY``, -``HTTP_PROXY`` and ``HTTPS_PROXY``, and the underlying Requests library will -pick them up as well. If you want to disable proxies configured through -the environment variables for certain hosts, you can specify them in ``NO_PROXY``. - -In your ``~/.bash_profile``: - -.. code-block:: bash - - export HTTP_PROXY=http://10.10.1.10:3128 - export HTTPS_PROXY=https://10.10.1.10:1080 - export NO_PROXY=localhost,example.com - - -SOCKS ------ - -Usage is the same as for other types of `proxies`_: - -.. code-block:: bash - - $ http --proxy=http:socks5://user:pass@host:port --proxy=https:socks5://user:pass@host:port example.org - - -HTTPS -===== - - -Server SSL certificate verification ------------------------------------ - -To skip the host’s SSL certificate verification, you can pass ``--verify=no`` -(default is ``yes``): - -.. code-block:: bash - - $ http --verify=no https://pie.dev/get - - -Custom CA bundle ----------------- - -You can also use ``--verify=`` to set a custom CA bundle path: - -.. code-block:: bash - - $ http --verify=/ssl/custom_ca_bundle https://example.org - - - -Client side SSL certificate ---------------------------- -To use a client side certificate for the SSL communication, you can pass -the path of the cert file with ``--cert``: - -.. code-block:: bash - - $ http --cert=client.pem https://example.org - - -If the private key is not contained in the cert file you may pass the -path of the key file with ``--cert-key``: - -.. code-block:: bash - - $ http --cert=client.crt --cert-key=client.key https://example.org - - -SSL version ------------ - -Use the ``--ssl=`` option to specify the desired protocol version to -use. This will default to SSL v2.3 which will negotiate the highest protocol -that both the server and your installation of OpenSSL support. The available -protocols are -``ssl2.3``, ``ssl3``, ``tls1``, ``tls1.1``, ``tls1.2``, ``tls1.3``. -(The actually available set of protocols may vary depending on your OpenSSL -installation.) - -.. code-block:: bash - - # Specify the vulnerable SSL v3 protocol to talk to an outdated server: - $ http --ssl=ssl3 https://vulnerable.example.org - - - -SSL ciphers ------------ - -You can specify the available ciphers with ``--ciphers``. -It should be a string in the -`OpenSSL cipher list format `_. - -.. code-block:: bash - - $ http --ciphers=ECDHE-RSA-AES128-GCM-SHA256 https://pie.dev/get - -Note: these cipher strings do not change the negotiated version of SSL or TLS, -they only affect the list of available cipher suites. - -To see the default cipher string, run ``http --help`` and see -the ``--ciphers`` section under SSL. - - - -Output options -============== - -By default, HTTPie only outputs the final response and the whole response -message is printed (headers as well as the body). You can control what should -be printed via several options: - -================= ===================================================== -``--headers, -h`` Only the response headers are printed. -``--body, -b`` Only the response body is printed. -``--verbose, -v`` Print the whole HTTP exchange (request and response). - This option also enables ``--all`` (see below). -``--print, -p`` Selects parts of the HTTP exchange. -``--quiet, -q`` Don't print anything to ``stdout`` and ``stderr``. -================= ===================================================== - - -What parts of the HTTP exchange should be printed -------------------------------------------------- - -All the other `output options`_ are under the hood just shortcuts for -the more powerful ``--print, -p``. It accepts a string of characters each -of which represents a specific part of the HTTP exchange: - -========== ================== -Character Stands for -========== ================== -``H`` request headers -``B`` request body -``h`` response headers -``b`` response body -========== ================== - -Print request and response headers: - -.. code-block:: bash - - $ http --print=Hh PUT pie.dev/put hello=world - -Verbose output --------------- - -``--verbose`` can often be useful for debugging the request and generating -documentation examples: - -.. code-block:: bash - - $ http --verbose PUT pie.dev/put hello=world - PUT /put HTTP/1.1 - Accept: application/json, */*;q=0.5 - Accept-Encoding: gzip, deflate - Content-Type: application/json - Host: pie.dev - User-Agent: HTTPie/0.2.7dev - - { - "hello": "world" - } - - - HTTP/1.1 200 OK - Connection: keep-alive - Content-Length: 477 - Content-Type: application/json - Date: Sun, 05 Aug 2012 00:25:23 GMT - Server: gunicorn/0.13.4 - - { - […] - } - -Quiet output ------------- - -``--quiet`` redirects all output that would otherwise go to ``stdout`` -and ``stderr`` to ``/dev/null`` (except for errors and warnings). -This doesn’t affect output to a file via ``--output`` or ``--download``. - -.. code-block:: bash - - # There will be no output: - $ http --quiet pie.dev/post enjoy='the silence' - - -Viewing intermediary requests/responses ---------------------------------------- - -To see all the HTTP communication, i.e. the final request/response as -well as any possible intermediary requests/responses, use the ``--all`` -option. The intermediary HTTP communication include followed redirects -(with ``--follow``), the first unauthorized request when HTTP digest -authentication is used (``--auth=digest``), etc. - -.. code-block:: bash - - # Include all responses that lead to the final one: - $ http --all --follow pie.dev/redirect/3 - - -The intermediary requests/response are by default formatted according to -``--print, -p`` (and its shortcuts described above). If you’d like to change -that, use the ``--history-print, -P`` option. It takes the same -arguments as ``--print, -p`` but applies to the intermediary requests only. - - -.. code-block:: bash - - # Print the intermediary requests/responses differently than the final one: - $ http -A digest -a foo:bar --all -p Hh -P H pie.dev/digest-auth/auth/foo/bar - - -Conditional body download -------------------------- - -As an optimization, the response body is downloaded from the server -only if it’s part of the output. This is similar to performing a ``HEAD`` -request, except that it applies to any HTTP method you use. - -Let’s say that there is an API that returns the whole resource when it is -updated, but you are only interested in the response headers to see the -status code after an update: - -.. code-block:: bash - - $ http --headers PATCH pie.dev/patch name='New Name' - - -Since we are only printing the HTTP headers here, the connection to the server -is closed as soon as all the response headers have been received. -Therefore, bandwidth and time isn’t wasted downloading the body -which you don’t care about. The response headers are downloaded always, -even if they are not part of the output - - -Raw request body -================ - -In addition to crafting structured `JSON`_ and `forms`_ requests with the -`request items`_ syntax, you can provide a raw request body that will be -sent without further processing. These two approaches for specifying request -data (i.e., structured and raw) cannot be combined. - -There’re three methods for passing raw request data: piping via ``stdin``, -``--raw='data'``, and ``@/file/path``. - - -Redirected Input ----------------- - -The universal method for passing request data is through redirected ``stdin`` -(standard input)—piping. - -By default, ``stdin`` data is buffered and then with no further processing -used as the request body. If you provide ``Content-Length``, then the request -body is streamed without buffering. You can also use ``--chunked`` to enable -streaming via `chunked transfer encoding`_. - -There are multiple useful ways to use piping: - -Redirect from a file: - -.. code-block:: bash - - $ http PUT pie.dev/put X-API-Token:123 < files/data.json - - -Or the output of another program: - -.. code-block:: bash - - $ grep '401 Unauthorized' /var/log/httpd/error_log | http POST pie.dev/post - - -You can use ``echo`` for simple data: - -.. code-block:: bash - - $ echo -n '{"name": "John"}' | http PATCH pie.dev/patch X-API-Token:123 - - -You can also use a Bash *here string*: - -.. code-block:: bash - - $ http pie.dev/post <<<'{"name": "John"}' - - -You can even pipe web services together using HTTPie: - -.. code-block:: bash - - $ http GET https://api.github.com/repos/httpie/httpie | http POST pie.dev/post - - -You can use ``cat`` to enter multiline data on the terminal: - -.. code-block:: bash - - $ cat | http POST pie.dev/post - - ^D - - -.. code-block:: bash - - $ cat | http POST pie.dev/post Content-Type:text/plain - - buy milk - - call parents - ^D - - -On OS X, you can send the contents of the clipboard with ``pbpaste``: - -.. code-block:: bash - - $ pbpaste | http PUT pie.dev/put - - -Passing data through ``stdin`` cannot be combined with data fields specified -on the command line: - -.. code-block:: bash - - $ echo -n 'data' | http POST example.org more=data # This is invalid - - -To prevent HTTPie from reading ``stdin`` data you can use the -``--ignore-stdin`` option. - - -Request data via ``--raw`` --------------------------- - -In a situation when piping data via ``stdin`` is not convenient (for example, -when generating API docs examples), you can specify the raw request body via -the ``--raw`` option. - -.. code-block:: bash - - $ http --raw 'Hello, world!' pie.dev/post - -.. code-block:: bash - - $ http --raw '{"name": "John"}' pie.dev/post - - -Request data from a filename ----------------------------- - -An alternative to redirected ``stdin`` is specifying a filename (as -``@/path/to/file``) whose content is used as if it came from ``stdin``. - -It has the advantage that the ``Content-Type`` -header is automatically set to the appropriate value based on the -filename extension. For example, the following request sends the -verbatim contents of that XML file with ``Content-Type: application/xml``: - -.. code-block:: bash - - $ http PUT pie.dev/put @files/data.xml - -File uploads are always streamed to avoid memory issues with large files. - - -Chunked transfer encoding -========================= - -You can use the ``--chunked`` flag to instruct HTTPie to use -``Transfer-Encoding: chunked``: - - -.. code-block:: bash - - $ http --chunked PUT pie.dev/put hello=world - -.. code-block:: bash - - $ http --chunked --multipart PUT pie.dev/put hello=world foo@files/data.xml - -.. code-block:: bash - - $ http --chunked pie.dev/post @files/data.xml - -.. code-block:: bash - - $ cat files/data.xml | http --chunked pie.dev/post - - - -Terminal output -=============== - -HTTPie does several things by default in order to make its terminal output -easy to read. - - -Colors and formatting ---------------------- - -Syntax highlighting is applied to HTTP headers and bodies (where it makes -sense). You can choose your preferred color scheme via the ``--style`` option -if you don’t like the default one. There dozens of styles available, here are just a few special or notable ones: - -==================== ======================================================================== -``auto`` Follows your terminal ANSI color styles. This is the default style used by HTTPie. -``default`` Default styles of the underlying Pygments library. Not actually used by default by HTTPie. - You can enable it with ``--style=default`` -``monokai`` A popular color scheme. Enable with ``--style=monokai``. -``fruity`` A bold, colorful scheme. Enable with ``--style=fruity``. -… See ``$ http --help`` for all the possible ``--style`` values. -==================== ======================================================================== - -Also, the following formatting is applied: - -* HTTP headers are sorted by name. -* JSON data is indented, sorted by keys, and unicode escapes are converted - to the characters they represent. - -One of these options can be used to control output processing: - -==================== ======================================================== -``--pretty=all`` Apply both colors and formatting. - Default for terminal output. -``--pretty=colors`` Apply colors. -``--pretty=format`` Apply formatting. -``--pretty=none`` Disables output processing. - Default for redirected output. -==================== ======================================================== - -You can further control the applied formatting via the more granular `format options`_. - - -Format options --------------- - -The ``--format-options=opt1:value,opt2:value`` option allows you to control how the output should be formatted -when formatting is applied. The following options are available: - -+-------------------------------+---------------+------------------------------+ -| Option | Default value | Shortcuts | -+===============================+===============+==============================+ -| ``headers.sort`` | ``true`` | ``--sorted``, ``--unsorted`` | -+-------------------------------+---------------+------------------------------+ -| ``json.format`` | ``true`` | N/A | -+-------------------------------+---------------+------------------------------+ -| ``json.indent`` | ``4`` | N/A | -+--------------------+----------+---------------+------------------------------+ -| ``json.sort_keys`` | ``true`` | ``--sorted``, ``--unsorted`` | -+--------------------+----------+---------------+------------------------------+ -| ``xml.format`` | ``true`` | N/A | -+-------------------------------+---------------+------------------------------+ -| ``xml.indent`` | ``2`` | N/A | -+--------------------+----------+---------------+------------------------------+ - -For example, this is how you would disable the default header and JSON key -sorting, and specify a custom JSON indent size: - -.. code-block:: bash - - $ http --format-options headers.sort:false,json.sort_keys:false,json.indent:2 pie.dev/get - -There are also two shortcuts that allow you to quickly disable and re-enable -sorting-related format options (currently it means JSON keys and headers): -``--unsorted`` and ``--sorted``. - -This is something you will typically store as one of the default options in your `config`_ file. - - -Binary data ------------ - -Binary data is suppressed for terminal output, which makes it safe to perform -requests to URLs that send back binary data. Binary data is suppressed also in -redirected, but prettified output. The connection is closed as soon as we know -that the response body is binary, - -.. code-block:: bash - - $ http pie.dev/bytes/2000 - - -You will nearly instantly see something like this: - -.. code-block:: http - - HTTP/1.1 200 OK - Content-Type: application/octet-stream - - +-----------------------------------------+ - | NOTE: binary data not shown in terminal | - +-----------------------------------------+ - - -Redirected output -================= - -HTTPie uses a different set of defaults for redirected output than for -`terminal output`_. The differences being: - -* Formatting and colors aren’t applied (unless ``--pretty`` is specified). -* Only the response body is printed (unless one of the `output options`_ is set). -* Also, binary data isn’t suppressed. - -The reason is to make piping HTTPie’s output to another programs and -downloading files work with no extra flags. Most of the time, only the raw -response body is of an interest when the output is redirected. - -Download a file: - -.. code-block:: bash - - $ http pie.dev/image/png > image.png - - -Download an image of Octocat, resize it using ImageMagick, upload it elsewhere: - -.. code-block:: bash - - $ http octodex.github.com/images/original.jpg | convert - -resize 25% - | http example.org/Octocats - - -Force colorizing and formatting, and show both the request and the response in -``less`` pager: - -.. code-block:: bash - - $ http --pretty=all --verbose pie.dev/get | less -R - - -The ``-R`` flag tells ``less`` to interpret color escape sequences included -HTTPie`s output. - -You can create a shortcut for invoking HTTPie with colorized and paged output -by adding the following to your ``~/.bash_profile``: - -.. code-block:: bash - - function httpless { - # `httpless example.org' - http --pretty=all --print=hb "$@" | less -R; - } - - -Download mode -============= - -HTTPie features a download mode in which it acts similarly to ``wget``. - -When enabled using the ``--download, -d`` flag, response headers are printed to -the terminal (``stderr``), and a progress bar is shown while the response body -is being saved to a file. - -.. code-block:: bash - - $ http --download https://github.com/httpie/httpie/archive/master.tar.gz - -.. code-block:: http - - HTTP/1.1 200 OK - Content-Disposition: attachment; filename=httpie-master.tar.gz - Content-Length: 257336 - Content-Type: application/x-gzip - - Downloading 251.30 kB to "httpie-master.tar.gz" - Done. 251.30 kB in 2.73862s (91.76 kB/s) - - -Downloaded filename --------------------- - -There are three mutually exclusive ways through which HTTPie determines -the output filename (with decreasing priority): - -1. You can explicitly provide it via ``--output, -o``. - The file gets overwritten if it already exists - (or appended to with ``--continue, -c``). -2. The server may specify the filename in the optional ``Content-Disposition`` - response header. Any leading dots are stripped from a server-provided filename. -3. The last resort HTTPie uses is to generate the filename from a combination - of the request URL and the response ``Content-Type``. - The initial URL is always used as the basis for - the generated filename — even if there has been one or more redirects. - - -To prevent data loss by overwriting, HTTPie adds a unique numerical suffix to the -filename when necessary (unless specified with ``--output, -o``). - - -Piping while downloading ------------------------- - -You can also redirect the response body to another program while the response -headers and progress are still shown in the terminal: - -.. code-block:: bash - - $ http -d https://github.com/httpie/httpie/archive/master.tar.gz | tar zxf - - - - -Resuming downloads ------------------- - -If ``--output, -o`` is specified, you can resume a partial download using the -``--continue, -c`` option. This only works with servers that support -``Range`` requests and ``206 Partial Content`` responses. If the server doesn’t -support that, the whole file will simply be downloaded: - -.. code-block:: bash - - $ http -dco file.zip example.org/file - -Other notes ------------ - -* The ``--download`` option only changes how the response body is treated. -* You can still set custom headers, use sessions, ``--verbose, -v``, etc. -* ``--download`` always implies ``--follow`` (redirects are followed). -* ``--download`` also implies ``--check-status`` - (error HTTP status will result in a non-zero exist static code). -* HTTPie exits with status code ``1`` (error) if the body hasn’t been fully - downloaded. -* ``Accept-Encoding`` cannot be set with ``--download``. - - -Streamed responses -================== - -Responses are downloaded and printed in chunks which allows for streaming -and large file downloads without using too much memory. However, when -`colors and formatting`_ is applied, the whole response is buffered and only -then processed at once. - - -Disabling buffering -------------------- - -You can use the ``--stream, -S`` flag to make two things happen: - -1. The output is flushed in much smaller chunks without any buffering, - which makes HTTPie behave kind of like ``tail -f`` for URLs. - -2. Streaming becomes enabled even when the output is prettified: It will be - applied to each line of the response and flushed immediately. This makes - it possible to have a nice output for long-lived requests, such as one - to the Twitter streaming API. - - -Examples use cases ------------------- - -Prettified streamed response: - -.. code-block:: bash - - $ http --stream pie.dev/stream/3 - - -Streamed output by small chunks à la ``tail -f``: - -.. code-block:: bash - - # Send each new line (JSON object) to another URL as soon as it arrives from a streaming API: - $ http --stream pie.dev/stream/3 | while read line; do echo "$line" | http pie.dev/post ; done - -Sessions -======== - -By default, every request HTTPie makes is completely independent of any -previous ones to the same host. - - -However, HTTPie also supports persistent -sessions via the ``--session=SESSION_NAME_OR_PATH`` option. In a session, -custom `HTTP headers`_ (except for the ones starting with ``Content-`` or ``If-``), -`authentication`_, and `cookies`_ -(manually specified or sent by the server) persist between requests -to the same host. - - -.. code-block:: bash - - # Create a new session: - $ http --session=./session.json pie.dev/headers API-Token:123 - - -.. code-block:: bash - - # Inspect / edit the generated session file: - $ cat session.json - -.. code-block:: bash - - # Re-use the existing session — the API-Token header will be set: - $ http --session=./session.json pie.dev/headers - - -All session data, including credentials, cookie data, -and custom headers are stored in plain text. -That means session files can also be created and edited manually in a text -editor—they are regular JSON. It also means that they can be read by anyone -who has access to the session file. - - -Named sessions --------------- - - -You can create one or more named session per host. For example, this is how -you can create a new session named ``user1`` for ``pie.dev``: - -.. code-block:: bash - - $ http --session=user1 -a user1:password pie.dev/get X-Foo:Bar - -From now on, you can refer to the session by its name (``user1``). When you choose -to use the session again, any previously specified authentication or HTTP headers -will automatically be set: - -.. code-block:: bash - - $ http --session=user1 pie.dev/get - -To create or reuse a different session, simple specify a different name: - -.. code-block:: bash - - $ http --session=user2 -a user2:password pie.dev/get X-Bar:Foo - -Named sessions’s data is stored in JSON files inside the ``sessions`` -subdirectory of the `config`_ directory, typically: -``~/.config/httpie/sessions//.json`` -(``%APPDATA%\httpie\sessions\\.json`` on Windows). - -If you have executed the above commands on a unix machine, -you should be able list the generated sessions files using: - - -.. code-block:: bash - - $ ls -l ~/.config/httpie/sessions/pie.dev - - -Anonymous sessions ------------------- - -Instead of a name, you can also directly specify a path to a session file. This -allows for sessions to be re-used across multiple hosts: - -.. code-block:: bash - - # Create a session: - $ http --session=/tmp/session.json example.org - - -.. code-block:: bash - - # Use the session to make a request to another host: - $ http --session=/tmp/session.json admin.example.org - -.. code-block:: bash - - # You can also refer to a previously created named session: - $ http --session=~/.config/httpie/sessions/another.example.org/test.json example.org - - -When creating anonymous sessions, please remember to always include at least -one ``/``, even if the session files is located in the current directory -(i.e., ``--session=./session.json`` instead of just ``--session=session.json``), -otherwise HTTPie assumes a named session instead. - - -Readonly session ----------------- - -To use an existing session file without updating it from the request/response -exchange after it has been created, specify the session name via -``--session-read-only=SESSION_NAME_OR_PATH`` instead. - -.. code-block:: bash - - # If the session file doesn’t exist, then it is created: - $ http --session-read-only=./ro-session.json pie.dev/headers Custom-Header:orig-value - -.. code-block:: bash - - # But it is not updated: - $ http --session-read-only=./ro-session.json pie.dev/headers Custom-Header:new-value - -Cookie Storage Behaviour ------------------------- - -**TL;DR:** Cookie storage priority: Server response > Command line request > Session file - -To set a cookie within a Session there are three options: - -1. Get a ``Set-Cookie`` header in a response from a server - -.. code-block:: bash - - $ http --session=./session.json pie.dev/cookie/set?foo=bar - -2. Set the cookie name and value through the command line as seen in `cookies`_ - -.. code-block:: bash - - $ http --session=./session.json pie.dev/headers Cookie:foo=bar - -3. Manually set cookie parameters in the json file of the session - -.. code-block:: json - - { - "__meta__": { - "about": "HTTPie session file", - "help": "https://httpie.org/doc#sessions", - "httpie": "2.2.0-dev" - }, - "auth": { - "password": null, - "type": null, - "username": null - }, - "cookies": { - "foo": { - "expires": null, - "path": "/", - "secure": false, - "value": "bar" - } - } - } - -Cookies will be set in the session file with the priority specified above. For example, a cookie -set through the command line will overwrite a cookie of the same name stored -in the session file. If the server returns a ``Set-Cookie`` header with a -cookie of the same name, the returned cookie will overwrite the preexisting cookie. - -Expired cookies are never stored. If a cookie in a session file expires, it will be removed before -sending a new request. If the server expires an existing cookie, it will also be removed from the -session file. - - -Config -====== - -HTTPie uses a simple ``config.json`` file. The file doesn’t exist by default -but you can create it manually. - - -Config file directory ---------------------- - -To see the exact location for your installation, run ``http --debug`` and -look for ``config_dir`` in the output. - -The default location of the configuration file on most platforms is -``$XDG_CONFIG_HOME/httpie/config.json`` (defaulting to -``~/.config/httpie/config.json``). - -For backwards compatibility, if the directory ``~/.httpie`` exists, -the configuration file there will be used instead. - -On Windows, the config file is located at ``%APPDATA%\httpie\config.json``. - -The config directory can be changed by setting the ``$HTTPIE_CONFIG_DIR`` -environment variable: - -.. code-block:: bash - - $ export HTTPIE_CONFIG_DIR=/tmp/httpie - $ http pie.dev/get - - - -Configurable options --------------------- - -Currently HTTPie offers a single configurable option: - - -``default_options`` -~~~~~~~~~~~~~~~~~~~ - -An ``Array`` (by default empty) of default options that should be applied to -every invocation of HTTPie. - -For instance, you can use this config option to change your default color theme: - - -.. code-block:: bash - - $ cat ~/.config/httpie/config.json - - -.. code-block:: json - - { - "default_options": [ - "--style=fruity" - ] - } - - -Even though it is technically possible to include there any of HTTPie’s -options, it is not recommended to modify the default behaviour in a way -that would break your compatibility with the wider world as that can -generate a lot of confusion. - - -Un-setting previously specified options ---------------------------------------- - -Default options from the config file, or specified any other way, -can be unset for a particular invocation via ``--no-OPTION`` arguments passed -on the command line (e.g., ``--no-style`` or ``--no-session``). - - - -Scripting -========= - -When using HTTPie from shell scripts, it can be handy to set the -``--check-status`` flag. It instructs HTTPie to exit with an error if the -HTTP status is one of ``3xx``, ``4xx``, or ``5xx``. The exit status will -be ``3`` (unless ``--follow`` is set), ``4``, or ``5``, -respectively. - -.. code-block:: bash - - #!/bin/bash - - if http --check-status --ignore-stdin --timeout=2.5 HEAD pie.dev/get &> /dev/null; then - echo 'OK!' - else - case $? in - 2) echo 'Request timed out!' ;; - 3) echo 'Unexpected HTTP 3xx Redirection!' ;; - 4) echo 'HTTP 4xx Client Error!' ;; - 5) echo 'HTTP 5xx Server Error!' ;; - 6) echo 'Exceeded --max-redirects= redirects!' ;; - *) echo 'Other Error!' ;; - esac - fi - - -Best practices --------------- - -The default behaviour of automatically reading ``stdin`` is typically not -desirable during non-interactive invocations. You most likely want to -use the ``--ignore-stdin`` option to disable it. - -It is a common gotcha that without this option HTTPie seemingly hangs. -What happens is that when HTTPie is invoked for example from a cron job, -``stdin`` is not connected to a terminal. -Therefore, rules for `redirected input`_ apply, i.e., HTTPie starts to read it -expecting that the request body will be passed through. -And since there’s no data nor ``EOF``, it will be stuck. So unless you’re -piping some data to HTTPie, this flag should be used in scripts. - -Also, it might be good to set a connection ``--timeout`` limit to prevent -your program from hanging if the server never responds. - - - -Meta -==== - -Interface design ----------------- - -The syntax of the command arguments closely corresponds to the actual HTTP -requests sent over the wire. It has the advantage that it’s easy to remember -and read. It is often possible to translate an HTTP request to an HTTPie -argument list just by inlining the request elements. For example, compare this -HTTP request: - -.. code-block:: http - - POST /post HTTP/1.1 - Host: pie.dev - X-API-Key: 123 - User-Agent: Bacon/1.0 - Content-Type: application/x-www-form-urlencoded - - name=value&name2=value2 - - -with the HTTPie command that sends it: - -.. code-block:: bash - - $ http -f POST pie.dev/post \ - X-API-Key:123 \ - User-Agent:Bacon/1.0 \ - name=value \ - name2=value2 - - -Notice that both the order of elements and the syntax is very similar, -and that only a small portion of the command is used to control HTTPie and -doesn’t directly correspond to any part of the request (here it’s only ``-f`` -asking HTTPie to send a form request). - -The two modes, ``--pretty=all`` (default for terminal) and ``--pretty=none`` -(default for redirected output), allow for both user-friendly interactive use -and usage from scripts, where HTTPie serves as a generic HTTP client. - -As HTTPie is still under heavy development, the existing command line -syntax and some of the ``--OPTIONS`` may change slightly before -HTTPie reaches its final version ``1.0``. All changes are recorded in the -`change log`_. - - - -Community and Support ---------------------- - -HTTPie has the following community channels: - -* `GitHub issues `_ - for bug reports and feature requests. -* `Discord server `_ - to ask questions, discuss features, and for general API development discussion. -* `StackOverflow `_ - to ask questions (please make sure to use the - `httpie `_ tag). -* Tweet directly to `@httpie `_. -* You can also tweet directly to `@jakubroztocil`_. - - -Related projects ----------------- - -Dependencies -~~~~~~~~~~~~ - -Under the hood, HTTPie uses these two amazing libraries: - -* `Requests `_ - — Python HTTP library for humans -* `Pygments `_ - — Python syntax highlighter - - -HTTPie friends -~~~~~~~~~~~~~~ - -HTTPie plays exceptionally well with the following tools: - -* `http-prompt `_ - — interactive shell for HTTPie featuring autocomplete - and command syntax highlighting -* `jq `_ - — CLI JSON processor that - works great in conjunction with HTTPie - -Helpers to convert from other client tools: - -* `CurliPie `_ help convert cURL command line to HTTPie command line. - - -Alternatives -~~~~~~~~~~~~ - -* `httpcat `_ — a lower-level sister utility - of HTTPie for constructing raw HTTP requests on the command line. -* `curl `_ — a "Swiss knife" command line tool and - an exceptional library for transferring data with URLs. - - -Contributing ------------- - -See `CONTRIBUTING.rst `_. - - -Change log ----------- - -See `CHANGELOG `_. - - -Artwork -------- - -* `Logo `_ by `Cláudia Delgado `_. -* `Animation `_ by `Allen Smith `_ of GitHub. - - - -Licence -------- - -BSD-3-Clause: `LICENSE `_. - - - -Authors -------- - -`Jakub Roztocil`_ (`@jakubroztocil`_) created HTTPie and `these fine people`_ -have contributed. - - -.. _pip: https://pip.pypa.io/en/stable/installing/ -.. _GitHub API: https://developer.github.com/v3/issues/comments/#create-a-comment -.. _these fine people: https://github.com/httpie/httpie/contributors -.. _Jakub Roztocil: https://roztocil.co -.. _@jakubroztocil: https://twitter.com/jakubroztocil - - -.. |docs| image:: https://img.shields.io/badge/stable%20docs-httpie.org%2Fdocs-brightgreen?style=flat-square - :target: https://httpie.org/docs - :alt: Stable documentation - -.. |pypi| image:: https://img.shields.io/pypi/v/httpie.svg?style=flat-square&label=latest%20stable%20version - :target: https://pypi.python.org/pypi/httpie - :alt: Latest version released on PyPi - -.. |coverage| image:: https://img.shields.io/codecov/c/github/httpie/httpie?style=flat-square - :target: https://codecov.io/gh/httpie/httpie - :alt: Test coverage - -.. |build| image:: https://github.com/httpie/httpie/workflows/Build/badge.svg - :target: https://github.com/httpie/httpie/actions - :alt: Build status of the master branch on Mac/Linux/Windows - -.. |gitter| image:: https://img.shields.io/badge/chat-on%20Discord-brightgreen?style=flat-square - :target: https://httpie.io/chat - :alt: Chat on Discord - -.. |downloads| image:: https://pepy.tech/badge/httpie - :target: https://pepy.tech/project/httpie - :alt: Download count diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000..4da6215c --- /dev/null +++ b/docs/README.md @@ -0,0 +1,1686 @@ +
+ +# HTTPie Documentation + +
+ +**HTTPie (pronounced aitch-tee-tee-pie) is a command-line HTTP client. +Its goal is to make CLI interaction with web services as human-friendly as possible. +HTTPie is designed for testing, debugging, and generally interacting with APIs & HTTP servers. +The http & https commands allow for creating and sending arbitrary HTTP requests. +They use simple and natural syntax and provide formatted and colorized output.** + +## About this document + +This documentation is best viewed at [httpie.io/docs](https://httpie.org/docs). + +You can select your corresponding HTTPie version as well as run examples directly from the browser using a [termible.io](https://termible.io?utm_source=httpie-readme) embedded terminal. + +If you are reading this on GitHub, then this text covers the current *development* version. +You are invited to submit fixes and improvements to the docs by editing [this file](https://github.com/httpie/httpie/blob/master/docs/README.md). + +## Main features + +- Expressive and intuitive syntax +- Formatted and colorized terminal output +- Built-in JSON support +- Forms and file uploads +- HTTPS, proxies, and authentication +- Arbitrary request data +- Custom headers +- Persistent sessions +- Wget-like downloads +- Linux, macOS and Windows support +- Plugins +- Documentation +- Test coverage + +## Installation + +### macOS + +On macOS, HTTPie can also be installed via [Homebrew](https://brew.sh/): + +```bash +$ brew install httpie +``` + +A MacPorts *port* is also available: + +```bash +$ port install httpie +``` + +### Linux + +Most Linux distributions provide a package that can be installed using the +system package manager, for example: + +```bash +# Debian, Ubuntu, etc. +$ apt install httpie +``` + +```bash +# Fedora +$ dnf install httpie +``` + +```bash +# CentOS, RHEL, ... +$ yum install httpie +``` + +```bash +# Gentoo +$ emerge httpie +``` + +```bash +# Arch Linux +$ pacman -S httpie +``` + +```bash +# Solus +$ eopkg install httpie +``` + +### Windows, etc. + +A universal installation method (that works on Linux, macOS and Windows, and always provides the latest version) is to use [pip](https://pypi.org/project/pip/): + +```bash +# Make sure we have an up-to-date version of pip and setuptools: +$ python -m pip install --upgrade pip setuptools + +$ python -m pip install --upgrade httpie +``` + +(If `pip` installation fails for some reason, you can try +`easy_install httpie` as a fallback.) + +Windows users can also install HTTPie with [Chocolatey](https://chocolatey.org): + +```bash +$ choco upgrade httpie +``` + +### Python version + +Python version 3.6 or greater is required. + +### Unstable version + +You can also install the latest unreleased development version directly from the `master` branch on GitHub. +It is a work-in-progress of a future stable release so the experience might be not as smooth. + +
+ +[![Build](https://img.shields.io/github/workflow/status/httpie/httpie/Build?color=%2373DC8C&label=Build&logo=github)](https://github.com/httpie/httpie/actions) + +
+ +You can install it on Linux, macOS or Windows with `pip`: + +```bash +$ python -m pip install --upgrade https://github.com/httpie/httpie/archive/master.tar.gz +``` + +Or on macOS with Homebrew: + +```bash +$ brew uninstall --force httpie +$ brew install --HEAD httpie +``` + +Verify that now you have the [current development version identifier](https://github.com/httpie/httpie/blob/master/httpie__init__.py#L6) with the `-dev` suffix, for example: + +```bash +$ http --version +# 2.5.0-dev +``` + +## Usage + +Hello World: + +```bash +$ https httpie.io/hello +``` + +Synopsis: + +```bash +$ http [flags] [METHOD] URL [ITEM [ITEM]] +``` + +See also `http --help`. + +### Examples + +Custom [HTTP method](#http-method), [HTTP headers](#http-headers) and [JSON](#json) data: + +```bash +$ http PUT pie.dev/put X-API-Token:123 name=John +``` + +Submitting [forms](#forms): + +```bash +$ http -f POST pie.dev/post hello=World +``` + +See the request that is being sent using one of the [output options](#output-options): + +```bash +$ http -v pie.dev/get +``` + +Build and print a request without sending it using [offline mode](#offline-mode): + +```bash +$ http --offline pie.dev/post hello=offline +``` + +Use [GitHub API](https://developer.github.com/v3/issues/comments/#create-a-comment) to post a comment on an [issue](https://github.com/httpie/httpie/issues/83) with [authentication](#authentication): + +```bash +$ http -a USERNAME POST https://api.github.com/repos/httpie/httpie/issues/83/comments body='HTTPie is awesome! :heart:' +``` + +Upload a file using [redirected input](#redirected-input): + +```bash +$ http pie.dev/post < files/data.json +``` + +Download a file and save it via [redirected output](#redirected-output): + +```bash +$ http pie.dev/image/png > image.png +``` + +Download a file `wget` style: + +```bash +$ http --download pie.dev/image/png +``` + +Use named [sessions](#sessions) to make certain aspects of the communication persistent between requests to the same host: + +```bash +$ http --session=logged-in -a username:password pie.dev/get API-Key:123 +``` + +```bash +$ http --session=logged-in pie.dev/headers +``` + +Set a custom `Host` header to work around missing DNS records: + +```bash +$ http localhost:8000 Host:example.com +``` + +## HTTP method + +The name of the HTTP method comes right before the URL argument: + +```bash +$ http DELETE pie.dev/delete +``` + +Which looks similar to the actual `Request-Line` that is sent: + +```http +DELETE /delete HTTP/1.1 +``` + +When the `METHOD` argument is omitted from the command, HTTPie defaults to either `GET` (with no request data) or `POST` (with request data). + +## Request URL + +The only information HTTPie needs to perform a request is a URL. + +The default scheme is `http://` and can be omitted from the argument: + +```bash +$ http example.org +# => http://example.org +``` + +HTTPie also installs an `https` executable, where the default scheme is `https://`: + +```bash +$ https example.org +# => https://example.org +``` + +### Querystring parameters + +If you find yourself manually constructing URLs with querystring parameters on the terminal, you may appreciate the `param==value` syntax for appending URL parameters. + +With that, you don’t have to worry about escaping the `&` separators for your shell. Additionally, any special characters in the parameter name or value get automatically URL-escaped (as opposed to the parameters specified in the full URL, which HTTPie doesn’t modify). + +```bash +$ http https://api.github.com/search/repositories q==httpie per_page==1 +``` + +```http +GET /search/repositories?q=httpie&per_page=1 HTTP/1.1 +``` + +### URL shortcuts for `localhost` + +Additionally, curl-like shorthand for localhost is supported. +This means that, for example, `:3000` would expand to `http://localhost:3000` +If the port is omitted, then port 80 is assumed. + +```bash +$ http :/foo +``` + +```http +GET /foo HTTP/1.1 +Host: localhost +``` + +```bash +$ http :3000/bar +``` + +```http +GET /bar HTTP/1.1 +Host: localhost:3000 +``` + +```bash +$ http : +``` + +```http +GET / HTTP/1.1 +Host: localhost +``` + +### Other default schemes + +When HTTPie is invoked as `https` then the default scheme is `https://` (`$ https example.org` will make a request to `https://example.org`). + +You can also use the `--default-scheme ` option to create shortcuts for other protocols than HTTP (possibly supported via [plugins](https://pypi.org/search/?q=httpie)). Example for the [httpie-unixsocket](https://github.com/httpie/httpie-unixsocket) plugin: + +```bash +# Before +$ http http+unix://%2Fvar%2Frun%2Fdocker.sock/info +``` + +```bash +# Create an alias +$ alias http-unix='http --default-scheme="http+unix"' +``` + +```bash +# Now the scheme can be omitted +$ http-unix %2Fvar%2Frun%2Fdocker.sock/info +``` + +### `--path-as-is` + +The standard behavior of HTTP clients is to normalize the path portion of URLs by squashing dot segments as a typically filesystem would: + +```bash +$ http -v example.org/./../../etc/password +``` + +```http +GET /etc/password HTTP/1.1 +``` + +The `--path-as-is` option allows you to disable this behavior: + +```bash +$ http --path-as-is -v example.org/./../../etc/password +``` + +```http +GET /../../etc/password HTTP/1.1 +``` + +## Request items + +There are a few different *request item* types that provide a convenient mechanism for specifying HTTP headers, simple JSON and form data, files, and URL parameters. + +They are key/value pairs specified after the URL. All have in common that they become part of the actual request that is sent and that their type is distinguished only by the separator used: `:`, `=`, `:=`, `==`, `@`, `=@`, and `:=@`. The ones with an `@` expect a file path as value. + +| Item Type | Description | +| -----------------------------------------------------------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| HTTP Headers `Name:Value` | Arbitrary HTTP header, e.g. `X-API-Token:123` | +| URL parameters `name==value` | Appends the given name/value pair as a querystring parameter to the URL. The `==` separator is used. | +| Data Fields `field=value`, `field=@file.txt` | Request data fields to be serialized as a JSON object (default), to be form-encoded (with `--form, -f`), or to be serialized as `multipart/form-data` (with `--multipart`) | +| Raw JSON fields `field:=json` | Useful when sending JSON and one or more fields need to be a `Boolean`, `Number`, nested `Object`, or an `Array`, e.g., `meals:='["ham","spam"]'` or `pies:=[1,2,3]` (note the quotes) | +| File upload fields `field@/dir/file`, `field@file;type=mime` | Only available with `--form`, `-f` and `--multipart`. For example `screenshot@~/Pictures/img.png`, or `'cv@cv.txt;type=text/markdown'`. With `--form`, the presence of a file field results in a `--multipart` request | + +Note that the structured data fields aren’t the only way to specify request data: +[raw request body](#raw-request-body) is a mechanism for passing arbitrary request data. + +### Escaping rules + +You can use `\` to escape characters that shouldn’t be used as separators (or parts thereof). For instance, `foo\==bar` will become a data key/value pair (`foo=` and `bar`) instead of a URL parameter. + +Often it is necessary to quote the values, e.g. `foo='bar baz'`. + +If any of the field names or headers starts with a minus (e.g. `-fieldname`), you need to place all such items after the special token `--` to prevent confusion with `--arguments`: + +```bash +$ http pie.dev/post -- -name-starting-with-dash=foo -Unusual-Header:bar +``` + +```http +POST /post HTTP/1.1 +-Unusual-Header: bar +Content-Type: application/json + +{ + "-name-starting-with-dash": "foo" +} +``` + +## JSON + +JSON is the *lingua franca* of modern web services and it is also the **implicit content type** HTTPie uses by default. + +Simple example: + +```bash +$ http PUT pie.dev/put name=John email=john@example.org +``` + +```http +PUT / HTTP/1.1 +Accept: application/json, */*;q=0.5 +Accept-Encoding: gzip, deflate +Content-Type: application/json +Host: pie.dev + +{ + "name": "John", + "email": "john@example.org" +} +``` + +### Default behavior + +If your command includes some data [request items](#request-items), they are serialized as a JSON object by default. HTTPie also automatically sets the following headers, both of which can be overwritten: + +| Header | Value | +| -------------: | ----------------------------- | +| `Content-Type` | `application/json` | +| `Accept` | `application/json, */*;q=0.5` | + +### Explicit JSON + +You can use `--json, -j` to explicitly set `Accept` to `application/json` regardless of whether you are sending data (it’s a shortcut for setting the header via the usual header notation: `http url Accept:'application/json, */*;q=0.5'`). +Additionally, HTTPie will try to detect JSON responses even when the `Content-Type` is incorrectly `text/plain` or unknown. + +### Non-string JSON fields + +Non-string JSON fields use the `:=` separator, which allows you to embed arbitrary JSON data into the resulting JSON object. +Additionally, text and raw JSON files can also be embedded into fields using `=@` and `:=@`: + +```bash +$ http PUT pie.dev/put \ + name=John \ # String (default) + age:=29 \ # Raw JSON — Number + married:=false \ # Raw JSON — Boolean + hobbies:='["http", "pies"]' \ # Raw JSON — Array + favorite:='{"tool": "HTTPie"}' \ # Raw JSON — Object + bookmarks:=@files/data.json \ # Embed JSON file + description=@files/text.txt # Embed text file +``` + +```http +PUT /person/1 HTTP/1.1 +Accept: application/json, */*;q=0.5 +Content-Type: application/json +Host: pie.dev + +{ + "age": 29, + "hobbies": [ + "http", + "pies" + ], + "description": "John is a nice guy who likes pies.", + "married": false, + "name": "John", + "favorite": { + "tool": "HTTPie" + }, + "bookmarks": { + "HTTPie": "https://httpie.org", + } +} +``` + +### Raw and complex JSON + +Please note that with the [request items](#request-items) data field syntax, commands can quickly become unwieldy when sending complex structures. +In such cases, it’s better to pass the full raw JSON data via [raw request body](#raw-request-body), for example: + +```bash +$ echo -n '{"hello": "world"}' | http POST pie.dev/post +``` + +```bash +$ http --raw '{"hello": "world"}' POST pie.dev/post +``` + +```bash +$ http POST pie.dev/post < files/data.json +``` + +Furthermore, the structure syntax only allows you to send an object as the JSON document, but not an array, etc. +Here, again, the solution is to use [redirected input](#redirected-input). + +## Forms + +Submitting forms is very similar to sending [JSON](#json) requests. +Often the only difference is in adding the `--form, -f` option, which ensures that data fields are serialized as, and `Content-Type` is set to `application/x-www-form-urlencoded; charset=utf-8`. +It is possible to make form data the implicit content type instead of JSON via the [config](#config) file. + +### Regular forms + +```bash +$ http --form POST pie.dev/post name='John Smith' +``` + +```http +POST /post HTTP/1.1 +Content-Type: application/x-www-form-urlencoded; charset=utf-8 + +name=John+Smith +``` + +### File upload forms + +If one or more file fields is present, the serialization and content type is `multipart/form-data`: + +```bash +$ http -f POST pie.dev/post name='John Smith' cv@~/files/data.xml +``` + +The request above is the same as if the following HTML form were submitted: + +```html +
+ + +
+``` + +Please note that `@` is used to simulate a file upload form field, whereas `=@` just embeds the file content as a regular text field value. + +When uploading files, their content type is inferred from the file name. You can manually override the inferred content type: + +```bash +$ http -f POST pie.dev/post name='John Smith' cv@'~/files/data.bin;type=application/pdf' +``` + +To perform a `multipart/form-data` request even without any files, use `--multipart` instead of `--form`: + +```bash +$ http --multipart --offline example.org hello=world +``` + +```http +POST / HTTP/1.1 +Content-Length: 129 +Content-Type: multipart/form-data; boundary=c31279ab254f40aeb06df32b433cbccb +Host: example.org + +--c31279ab254f40aeb06df32b433cbccb +Content-Disposition: form-data; name="hello" + +world +--c31279ab254f40aeb06df32b433cbccb-- +``` + +File uploads are always streamed to avoid memory issues with large files. + +By default, HTTPie uses a random unique string as the multipart boundary but you can use `--boundary` to specify a custom string instead: + +```bash +$ http --form --multipart --boundary=xoxo --offline example.org hello=world +``` + +```http +POST / HTTP/1.1 +Content-Length: 129 +Content-Type: multipart/form-data; boundary=xoxo +Host: example.org + +--xoxo +Content-Disposition: form-data; name="hello" + +world +--xoxo-- +``` + +If you specify a custom `Content-Type` header without including the boundary bit, HTTPie will add the boundary value (explicitly specified or auto-generated) to the header automatically: + +```bash +$ http --form --multipart --offline example.org hello=world Content-Type:multipart/letter +``` + +```http +POST / HTTP/1.1 +Content-Length: 129 +Content-Type: multipart/letter; boundary=c31279ab254f40aeb06df32b433cbccb +Host: example.org + +--c31279ab254f40aeb06df32b433cbccb +Content-Disposition: form-data; name="hello" + +world +--c31279ab254f40aeb06df32b433cbccb-- +``` + +## HTTP headers + +To set custom headers you can use the `Header:Value` notation: + +```bash +$ http pie.dev/headers User-Agent:Bacon/1.0 'Cookie:valued-visitor=yes;foo=bar' \ + X-Foo:Bar Referer:https://httpie.org/ +``` + +```http +GET /headers HTTP/1.1 +Accept: */* +Accept-Encoding: gzip, deflate +Cookie: valued-visitor=yes;foo=bar +Host: pie.dev +Referer: https://httpie.org/ +User-Agent: Bacon/1.0 +X-Foo: Bar +``` + +### Default request headers + +There are a couple of default headers that HTTPie sets: + +```http +GET / HTTP/1.1 +Accept: */* +Accept-Encoding: gzip, deflate +User-Agent: HTTPie/ +Host: +``` + +Any of these can be overwritten and some of them unset (see below). + +### Empty headers and header un-setting + +To unset a previously specified header (such a one of the default headers), use `Header:`: + +```bash +$ http pie.dev/headers Accept: User-Agent: +``` + +To send a header with an empty value, use `Header;`, with a semicolon: + +```bash +$ http pie.dev/headers 'Header;' +``` + +### Limiting response headers + +The `--max-headers=n` options allows you to control the number of headers HTTPie reads before giving up (the default `0`, i.e., there’s no limit). + +```bash +$ http --max-headers=100 pie.dev/get +``` + +## Offline mode + +Use `--offline` to construct HTTP requests without sending them anywhere. +With `--offline`, HTTPie builds a request based on the specified options and arguments, prints it to `stdout`, and then exits. It works completely offline; no network connection is ever made. This has a number of use cases, including: + +Generating API documentation examples that you can copy & paste without sending a request: + +```bash +$ http --offline POST server.chess/api/games API-Key:ZZZ w=magnus b=hikaru t=180 i=2 +``` + +```bash +$ http --offline MOVE server.chess/api/games/123 API-Key:ZZZ p=b a=R1a3 t=77 +``` + +Generating raw requests that can be sent with any other client: + +```bash +# 1. save a raw request to a file: +$ http --offline POST pie.dev/post hello=world > request.http +``` + +```bash +# 2. send it over the wire with, for example, the fantastic netcat tool: +$ nc pie.dev 80 < request.http +``` + +You can also use the `--offline` mode for debugging and exploring HTTP and HTTPie, and for “dry runs”. + +`--offline` has the side-effect of automatically activating `--print=HB`, i.e., both the request headers and the body +are printed. You can customize the output with the usual [output options](#output-options), with the exception where there +is no response to be printed. You can use `--offline` in combination with all the other options (e.g. `--session`). + +## Cookies + +HTTP clients send cookies to the server as regular [HTTP headers](#http-headers). +That means, HTTPie does not offer any special syntax for specifying cookies — the usual `Header:Value` notation is used: + +Send a single cookie: + +```bash +$ http pie.dev/cookies Cookie:sessionid=foo +``` + +```http +GET / HTTP/1.1 +Accept: */* +Accept-Encoding: gzip, deflate +Connection: keep-alive +Cookie: sessionid=foo +Host: pie.dev +User-Agent: HTTPie/0.9.9 +``` + +Send multiple cookies (note: the header is quoted to prevent the shell from interpreting the `;`): + +```bash +$ http pie.dev/cookies 'Cookie:sessionid=foo;another-cookie=bar' +``` + +```http +GET / HTTP/1.1 +Accept: */* +Accept-Encoding: gzip, deflate +Connection: keep-alive +Cookie: sessionid=foo;another-cookie=bar +Host: pie.dev +User-Agent: HTTPie/0.9.9 +``` + +If you often deal with cookies in your requests, then you’d appreciate +the [sessions](#sessions) feature. + +## Authentication + +The currently supported authentication schemes are Basic and Digest (see [auth plugins](#auth-plugins) for more). There are two flags that control authentication: + +| Flag | Arguments | +| ----------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `--auth, -a` | Pass a `username:password` pair as the argument. Or, if you only specify a username (`-a username`), you’ll be prompted for the password before the request is sent. To send an empty password, pass `username:`. The `username:password@hostname` URL syntax is supported as well (but credentials passed via `-a` have higher priority) | +| `--auth-type, -A` | Specify the auth mechanism. Possible values are `basic`, `digest`, or the name of any [auth plugins](#auth-plugins) you have installed. The default value is `basic` so it can often be omitted | + +### Basic auth + +```bash +$ http -a username:password pie.dev/basic-auth/username/password +``` + +### Digest auth + +```bash +$ http -A digest -a username:password pie.dev/digest-auth/httpie/username/password +``` + +### Password prompt + +```bash +$ http -a username pie.dev/basic-auth/username/password +``` + +### Empty password + +```bash +$ http -a username: pie.dev/headers +``` + +### `.netrc` + +Authentication information from your `~/.netrc` file is by default honored as well. + +For example: + +```bash +$ cat ~/.netrc +machine pie.dev +login httpie +password test +``` + +```bash +$ http pie.dev/basic-auth/httpie/test +HTTP/1.1 200 OK +[...] +``` + +This can be disabled with the `--ignore-netrc` option: + +```bash +$ http --ignore-netrc pie.dev/basic-auth/httpie/test +HTTP/1.1 401 UNAUTHORIZED +[...] +``` + +### Auth plugins + +Additional authentication mechanism can be installed as plugins. +They can be found on the [Python Package Index](https://pypi.python.org/pypi?%3Aaction=search&term=httpie&submit=search). +Here are a few picks: + +- [httpie-api-auth](https://github.com/pd/httpie-api-auth): ApiAuth +- [httpie-aws-auth](https://github.com/httpie/httpie-aws-auth): AWS / Amazon S3 +- [httpie-edgegrid](https://github.com/akamai-open/httpie-edgegrid): EdgeGrid +- [httpie-hmac-auth](https://github.com/guardian/httpie-hmac-auth): HMAC +- [httpie-jwt-auth](https://github.com/teracyhq/httpie-jwt-auth): JWTAuth (JSON Web Tokens) +- [httpie-negotiate](https://github.com/ndzou/httpie-negotiate): SPNEGO (GSS Negotiate) +- [httpie-ntlm](https://github.com/httpie/httpie-ntlm): NTLM (NT LAN Manager) +- [httpie-oauth](https://github.com/httpie/httpie-oauth): OAuth +- [requests-hawk](https://github.com/mozilla-services/requests-hawk): Hawk + +## HTTP redirects + +By default, HTTP redirects are not followed and only the first +response is shown: + +```bash +$ http pie.dev/redirect/3 +``` + +### Follow `Location` + +To instruct HTTPie to follow the `Location` header of `30x` responses +and show the final response instead, use the `--follow, -F` option: + +```bash +$ http --follow pie.dev/redirect/3 +``` + +With `307 Temporary Redirect` and `308 Permanent Redirect`, the method and the body of the original request +are reused to perform the redirected request. Otherwise, a body-less `GET` request is performed. + +### Showing intermediary redirect responses + +If you wish to see the intermediary requests/responses, +then use the `--all` option: + +```bash +$ http --follow --all pie.dev/redirect/3 +``` + +### Limiting maximum redirects followed + +To change the default limit of maximum `30` redirects, use the `--max-redirects=` option: + +```bash +$ http --follow --all --max-redirects=2 pie.dev/redirect/3 +``` + +## Proxies + +You can specify proxies to be used through the `--proxy` argument for each protocol (which is included in the value in case of redirects across protocols): + +```bash +$ http --proxy=http:http://10.10.1.10:3128 --proxy=https:https://10.10.1.10:1080 example.org +``` + +With Basic authentication: + +```bash +$ http --proxy=http:http://user:pass@10.10.1.10:3128 example.org +``` + +### Environment variables + +You can also configure proxies by environment variables `ALL_PROXY`, `HTTP_PROXY` and `HTTPS_PROXY`, and the underlying [Requests library](https://python-requests.org/) will pick them up. +If you want to disable proxies configured through the environment variables for certain hosts, you can specify them in `NO_PROXY`. + +In your `~/.bash_profile`: + +```bash +export HTTP_PROXY=http://10.10.1.10:3128 +export HTTPS_PROXY=https://10.10.1.10:1080 +export NO_PROXY=localhost,example.com +``` + +### SOCKS + +Usage for SOCKS is the same as for other types of [proxies](#proxies): + +```bash +$ http --proxy=http:socks5://user:pass@host:port --proxy=https:socks5://user:pass@host:port example.org +``` + +## HTTPS + +### Server SSL certificate verification + +To skip the host’s SSL certificate verification, you can pass `--verify=no` (default is `yes`): + +```bash +$ http --verify=no https://pie.dev/get +``` + +### Custom CA bundle + +You can also use `--verify=` to set a custom CA bundle path: + +```bash +$ http --verify=/ssl/custom_ca_bundle https://example.org +``` + +### Client side SSL certificate + +To use a client side certificate for the SSL communication, you can pass +the path of the cert file with `--cert`: + +```bash +$ http --cert=client.pem https://example.org +``` + +If the private key is not contained in the cert file, you may pass the +path of the key file with `--cert-key`: + +```bash +$ http --cert=client.crt --cert-key=client.key https://example.org +``` + +### SSL version + +Use the `--ssl=` option to specify the desired protocol version to use. +This will default to SSL v2.3 which will negotiate the highest protocol that both the server and your installation of OpenSSL support. +The available protocols are `ssl2.3`, `ssl3`, `tls1`, `tls1.1`, `tls1.2`, `tls1.3`. +(The actually available set of protocols may vary depending on your OpenSSL installation.) + +```bash +# Specify the vulnerable SSL v3 protocol to talk to an outdated server: +$ http --ssl=ssl3 https://vulnerable.example.org +``` + +### SSL ciphers + +You can specify the available ciphers with `--ciphers`. +It should be a string in the [OpenSSL cipher list format](https://www.openssl.org/docs/man1.1.0/man1/ciphers.html). + +```bash +$ http --ciphers=ECDHE-RSA-AES128-GCM-SHA256 https://pie.dev/get +``` + +Note: these cipher strings do not change the negotiated version of SSL or TLS, they only affect the list of available cipher suites. + +To see the default cipher string, run `http --help` and see the `--ciphers` section under SSL. + +## Output options + +By default, HTTPie only outputs the final response and the whole response +message is printed (headers as well as the body). You can control what should +be printed via several options: + +| Option | What is printed | +| --------------: | -------------------------------------------------------------------------------------------------- | +| `--headers, -h` | Only the response headers are printed | +| `--body, -b` | Only the response body is printed | +| `--verbose, -v` | Print the whole HTTP exchange (request and response). This option also enables `--all` (see below) | +| `--print, -p` | Selects parts of the HTTP exchange | +| `--quiet, -q` | Don't print anything to `stdout` and `stderr` | + +### What parts of the HTTP exchange should be printed + +All the other [output options](#output-options) are under the hood just shortcuts for the more powerful `--print, -p`. +It accepts a string of characters each of which represents a specific part of the HTTP exchange: + +| Character | Stands for | +| --------: | ---------------- | +| `H` | request headers | +| `B` | request body | +| `h` | response headers | +| `b` | response body | + +Print request and response headers: + +```bash +$ http --print=Hh PUT pie.dev/put hello=world +``` + +### Verbose output + +`--verbose` can often be useful for debugging the request and generating documentation examples: + +```bash +$ http --verbose PUT pie.dev/put hello=world +PUT /put HTTP/1.1 +Accept: application/json, */*;q=0.5 +Accept-Encoding: gzip, deflate +Content-Type: application/json +Host: pie.dev +User-Agent: HTTPie/0.2.7dev + +{ + "hello": "world" +} + +HTTP/1.1 200 OK +Connection: keep-alive +Content-Length: 477 +Content-Type: application/json +Date: Sun, 05 Aug 2012 00:25:23 GMT +Server: gunicorn/0.13.4 + +{ + […] +} +``` + +### Quiet output + +`--quiet` redirects all output that would otherwise go to `stdout` and `stderr` to `/dev/null` (except for errors and warnings). +This doesn’t affect output to a file via `--output` or `--download`. + +```bash +# There will be no output: +$ http --quiet pie.dev/post enjoy='the silence' +``` + +### Viewing intermediary requests/responses + +To see all the HTTP communication, i.e. the final request/response as well as any possible intermediary requests/responses, use the `--all` option. +The intermediary HTTP communication include followed redirects (with `--follow`), the first unauthorized request when HTTP digest authentication is used (`--auth=digest`), etc. + +```bash +# Include all responses that lead to the final one: +$ http --all --follow pie.dev/redirect/3 +``` + +The intermediary requests/responses are by default formatted according to `--print, -p` (and its shortcuts described above). + +If you’d like to change that, use the `--history-print, -P` option. +It takes the same arguments as `--print, -p` but applies to the intermediary requests only. + +```bash +# Print the intermediary requests/responses differently than the final one: +$ http -A digest -a foo:bar --all -p Hh -P H pie.dev/digest-auth/auth/foo/bar +``` + +### Conditional body download + +As an optimization, the response body is downloaded from the server only if it’s part of the output. +This is similar to performing a `HEAD` request, except that it applies to any HTTP method you use. + +Let’s say that there is an API that returns the whole resource when it is updated, but you are only interested in the response headers to see the status code after an update: + +```bash +$ http --headers PATCH pie.dev/patch name='New Name' +``` + +Since you are only printing the HTTP headers here, the connection to the server is closed as soon as all the response headers have been received. +Therefore, bandwidth and time isn’t wasted downloading the body which you don’t care about. +The response headers are downloaded always, even if they are not part of the output + +## Raw request body + +In addition to crafting structured [JSON](#json) and [forms](#forms) requests with the [request items](#request-items) syntax, you can provide a raw request body that will be sent without further processing. +These two approaches for specifying request data (i.e., structured and raw) cannot be combined. + +There’re three methods for passing raw request data: piping via `stdin`, +`--raw='data'`, and `@/file/path`. + +### Redirected Input + +The universal method for passing request data is through redirected `stdin` +(standard input)—piping. + +By default, `stdin` data is buffered and then with no further processing used as the request body. +If you provide `Content-Length`, then the request body is streamed without buffering. +You may also use `--chunked` to enable streaming via [chunked transfer encoding](#chunked-transfer-encoding). + +There are multiple useful ways to use piping: + +Redirect from a file: + +```bash +$ http PUT pie.dev/put X-API-Token:123 < files/data.json +``` + +Or the output of another program: + +```bash +$ grep '401 Unauthorized' /var/log/httpd/error_log | http POST pie.dev/post +``` + +You can use `echo` for simple data: + +```bash +$ echo -n '{"name": "John"}' | http PATCH pie.dev/patch X-API-Token:123 +``` + +You can also use a Bash *here string*: + +```bash +$ http pie.dev/post <<<'{"name": "John"}' +``` + +You can even pipe web services together using HTTPie: + +```bash +$ http GET https://api.github.com/repos/httpie/httpie | http POST pie.dev/post +``` + +You can use `cat` to enter multiline data on the terminal: + +```bash +$ cat | http POST pie.dev/post + +^D +``` + +```bash +$ cat | http POST pie.dev/post Content-Type:text/plain +- buy milk +- call parents +^D +``` + +On macOS, you can send the contents of the clipboard with `pbpaste`: + +```bash +$ pbpaste | http PUT pie.dev/put +``` + +Passing data through `stdin` **can't** be combined with data fields specified on the command line: + +```bash +$ echo -n 'data' | http POST example.org more=data # This is invalid +``` + +To prevent HTTPie from reading `stdin` data you can use the `--ignore-stdin` option. + +### Request data via `--raw` + +In a situation when piping data via `stdin` is not convenient (for example, +when generating API docs examples), you can specify the raw request body via +the `--raw` option. + +```bash +$ http --raw 'Hello, world!' pie.dev/post +``` + +```bash +$ http --raw '{"name": "John"}' pie.dev/post +``` + +### Request data from a filename + +An alternative to redirected `stdin` is specifying a filename (as `@/path/to/file`) whose content is used as if it came from `stdin`. + +It has the advantage that the `Content-Type` header is automatically set to the appropriate value based on the filename extension. +For example, the following request sends the verbatim contents of that XML file with `Content-Type: application/xml`: + +```bash +$ http PUT pie.dev/put @files/data.xml +``` + +File uploads are always streamed to avoid memory issues with large files. + +## Chunked transfer encoding + +You can use the `--chunked` flag to instruct HTTPie to use `Transfer-Encoding: chunked`: + +```bash +$ http --chunked PUT pie.dev/put hello=world +``` + +```bash +$ http --chunked --multipart PUT pie.dev/put hello=world foo@files/data.xml +``` + +```bash +$ http --chunked pie.dev/post @files/data.xml +``` + +```bash +$ cat files/data.xml | http --chunked pie.dev/post +``` + +## Terminal output + +HTTPie does several things by default in order to make its terminal output easy to read. + +### Colors and formatting + +Syntax highlighting is applied to HTTP headers and bodies (where it makes sense). +You can choose your preferred color scheme via the `--style` option if you don’t like the default one. +There are dozens of styles available, here are just a few notable ones: + +| Style | Description | +| --------: | ----------------------------------------------------------------------------------------------------------------------------------- | +| `auto` | Follows your terminal ANSI color styles. This is the default style used by HTTPie | +| `default` | Default styles of the underlying Pygments library. Not actually used by default by HTTPie. You can enable it with `--style=default` | +| `monokai` | A popular color scheme. Enable with `--style=monokai` | +| `fruity` | A bold, colorful scheme. Enable with `--style=fruity` | +| … | See `$ http --help` for all the possible `--style` values | + +Also, the following formatting is applied: + +- HTTP headers are sorted by name. +- JSON data is indented, sorted by keys, and unicode escapes are converted + to the characters they represent. + +Use one of these options to control output processing: + +| Option | Description | +| ----------------: | ------------------------------------------------------------- | +| `--pretty=all` | Apply both colors and formatting. Default for terminal output | +| `--pretty=colors` | Apply colors | +| `--pretty=format` | Apply formatting | +| `--pretty=none` | Disables output processing. Default for redirected output | + +You can further control the applied formatting via the more granular [format options](#format-options). + +### Format options + +The `--format-options=opt1:value,opt2:value` option allows you to control how the output should be formatted +when formatting is applied. The following options are available: + +| Option | Default value | Shortcuts | +| ---------------: | :-----------: | ------------------------ | +| `headers.sort` | `true` | `--sorted`, `--unsorted` | +| `json.format` | `true` | N/A | +| `json.indent` | `4` | N/A | +| `json.sort_keys` | `true` | `--sorted`, `--unsorted` | +| `xml.format` | `true` | N/A | +| `xml.indent` | `2` | N/A | + +For example, this is how you would disable the default header and JSON key +sorting, and specify a custom JSON indent size: + +```bash +$ http --format-options headers.sort:false,json.sort_keys:false,json.indent:2 pie.dev/get +``` + +There are also two shortcuts that allow you to quickly disable and re-enable +sorting-related format options (currently it means JSON keys and headers): +`--unsorted` and `--sorted`. + +This is something you will typically store as one of the default options in your [config](#config) file. + +### Binary data + +Binary data is suppressed for terminal output, which makes it safe to perform requests to URLs that send back binary data. +Binary data is also suppressed in redirected but prettified output. +The connection is closed as soon as we know that the response body is binary, + +```bash +$ http pie.dev/bytes/2000 +``` + +You will nearly instantly see something like this: + +```http +HTTP/1.1 200 OK +Content-Type: application/octet-stream + ++-----------------------------------------+ +| NOTE: binary data not shown in terminal | ++-----------------------------------------+ +``` + +### Redirected output + +HTTPie uses a different set of defaults for redirected output than for [terminal output](#terminal-output). +The differences being: + +- Formatting and colors aren’t applied (unless `--pretty` is specified). +- Only the response body is printed (unless one of the [output options](#output-options) is set). +- Also, binary data isn’t suppressed. + +The reason is to make piping HTTPie’s output to another programs and downloading files work with no extra flags. +Most of the time, only the raw response body is of an interest when the output is redirected. + +Download a file: + +```bash +$ http pie.dev/image/png > image.png +``` + +Download an image of an [Octocat](https://octodex.github.com/images/original.jpg), resize it using [ImageMagick](https://imagemagick.org/), and upload it elsewhere: + +```bash +$ http octodex.github.com/images/original.jpg | convert - -resize 25% - | http example.org/Octocats +``` + +Force colorizing and formatting, and show both the request and the response in `less` pager: + +```bash +$ http --pretty=all --verbose pie.dev/get | less -R +``` + +The `-R` flag tells `less` to interpret color escape sequences included HTTPie’s output. + +You can create a shortcut for invoking HTTPie with colorized and paged output by adding the following to your `~/.bash_profile`: + +```bash +function httpless { + # `httpless example.org' + http --pretty=all --print=hb "$@" | less -R; +} +``` + +## Download mode + +HTTPie features a download mode in which it acts similarly to `wget`. + +When enabled using the `--download, -d` flag, response headers are printed to the terminal (`stderr`), and a progress bar is shown while the response body is being saved to a file. + +```bash +$ http --download https://github.com/httpie/httpie/archive/master.tar.gz +``` + +```http +HTTP/1.1 200 OK +Content-Disposition: attachment; filename=httpie-master.tar.gz +Content-Length: 257336 +Content-Type: application/x-gzip + +Downloading 251.30 kB to "httpie-master.tar.gz" +Done. 251.30 kB in 2.73862s (91.76 kB/s) +``` + +### Downloaded filename + +There are three mutually exclusive ways through which HTTPie determines +the output filename (with decreasing priority): + +1. You can explicitly provide it via `--output, -o`. The file gets overwritten if it already exists (or appended to with `--continue, -c`). +2. The server may specify the filename in the optional `Content-Disposition` response header. Any leading dots are stripped from a server-provided filename. +3. The last resort HTTPie uses is to generate the filename from a combination of the request URL and the response `Content-Type`. The initial URL is always used as the basis for the generated filename — even if there has been one or more redirects. + +To prevent data loss by overwriting, HTTPie adds a unique numerical suffix to the filename when necessary (unless specified with `--output, -o`). + +### Piping while downloading + +You can also redirect the response body to another program while the response headers and progress are still shown in the terminal: + +```bash +$ http -d https://github.com/httpie/httpie/archive/master.tar.gz | tar zxf - +``` + +### Resuming downloads + +If `--output, -o` is specified, you can resume a partial download using the `--continue, -c` option. +This only works with servers that support `Range` requests and `206 Partial Content` responses. +If the server doesn’t support that, the whole file will simply be downloaded: + +```bash +$ http -dco file.zip example.org/file +``` + +`-dco` is shorthand for `--download` `--continue` `--output`. + +### Other notes + +- The `--download` option only changes how the response body is treated. +- You can still set custom headers, use sessions, `--verbose, -v`, etc. +- `--download` always implies `--follow` (redirects are followed). +- `--download` also implies `--check-status` (error HTTP status will result in a non-zero exist static code). +- HTTPie exits with status code `1` (error) if the body hasn’t been fully downloaded. +- `Accept-Encoding` can't be set with `--download`. + +## Streamed responses + +Responses are downloaded and printed in chunks. +This allows for streaming and large file downloads without using too much memory. +However, when [colors and formatting](#colors-and-formatting) are applied, the whole response is buffered and only then processed at once. + +### Disabling buffering + +You can use the `--stream, -S` flag to make two things happen: + +1. The output is flushed in much smaller chunks without any buffering, which makes HTTPie behave kind of like `tail -f` for URLs. +2. Streaming becomes enabled even when the output is prettified: It will be applied to each line of the response and flushed immediately. This makes it possible to have a nice output for long-lived requests, such as one to the [Twitter streaming API](https://developer.twitter.com/en/docs/tutorials/consuming-streaming-data). + +### Example use cases + +Prettified streamed response: + +```bash +$ http --stream pie.dev/stream/3 +``` + +Streamed output by small chunks à la `tail -f`: + +```bash +# Send each new line (JSON object) to another URL as soon as it arrives from a streaming API: +$ http --stream pie.dev/stream/3 | while read line; do echo "$line" | http pie.dev/post ; done +``` + +## Sessions + +By default, every request HTTPie makes is completely independent of any previous ones to the same host. + +However, HTTPie also supports persistent sessions via the `--session=SESSION_NAME_OR_PATH` option. +In a session, custom [HTTP headers](#http-headers) (except for the ones starting with `Content-` or `If-`), [authentication](#authentication), and [cookies](#cookies) (manually specified or sent by the server) persist between requests to the same host. + +```bash +# Create a new session: +$ http --session=./session.json pie.dev/headers API-Token:123 +``` + +```bash +# Inspect / edit the generated session file: +$ cat session.json +``` + +```bash +# Re-use the existing session — the API-Token header will be set: +$ http --session=./session.json pie.dev/headers +``` + +All session data, including credentials, cookie data, and custom headers are stored in plain text. +That means session files can also be created and edited manually in a text editor—they are regular JSON. +It also means that they can be read by anyone who has access to the session file. + +### Named sessions + +You can create one or more named session per host. For example, this is how you can create a new session named `user1` for `pie.dev`: + +```bash +$ http --session=user1 -a user1:password pie.dev/get X-Foo:Bar +``` + +From now on, you can refer to the session by its name (`user1`). +When you choose to use the session again, all previously specified authentication or HTTP headers will automatically be set: + +```bash +$ http --session=user1 pie.dev/get +``` + +To create or reuse a different session, simply specify a different name: + +```bash +$ http --session=user2 -a user2:password pie.dev/get X-Bar:Foo +``` + +Named sessions’ data is stored in JSON files inside the `sessions` subdirectory of the [config](#config) directory, typically `~/.config/httpie/sessions//.json` (`%APPDATA%\httpie\sessions\\.json` on Windows). + +If you have executed the above commands on a Unix machine, you should be able list the generated sessions files using: + +```bash +$ ls -l ~/.config/httpie/sessions/pie.dev +``` + +### Anonymous sessions + +Instead of giving it a name, you can also directly specify a path to a session file. +This allows for sessions to be re-used across multiple hosts: + +```bash +# Create a session: +$ http --session=/tmp/session.json example.org +``` + +```bash +# Use the session to make a request to another host: +$ http --session=/tmp/session.json admin.example.org +``` + +```bash +# You can also refer to a previously created named session: +$ http --session=~/.config/httpie/sessions/another.example.org/test.json example.org +``` + +When creating anonymous sessions, please remember to always include at least one `/`, even if the session files is located in the current directory (i.e. `--session=./session.json` instead of just `--session=session.json`), otherwise HTTPie assumes a named session instead. + +### Readonly session + +To use the original session file without updating it from the request/response exchange after it has been created, specify the session name via `--session-read-only=SESSION_NAME_OR_PATH` instead. + +```bash +# If the session file doesn’t exist, then it is created: +$ http --session-read-only=./ro-session.json pie.dev/headers Custom-Header:orig-value +``` + +```bash +# But it is not updated: +$ http --session-read-only=./ro-session.json pie.dev/headers Custom-Header:new-value +``` + +### Cookie Storage Behavior + +**TL;DR:** Cookie storage priority: Server response > Command line request > Session file + +To set a cookie within a Session there are three options: + +1. Get a `Set-Cookie` header in a response from a server + +```bash +$ http --session=./session.json pie.dev/cookie/set?foo=bar +``` + +2. Set the cookie name and value through the command line as seen in [cookies](#cookies) + +```bash +$ http --session=./session.json pie.dev/headers Cookie:foo=bar +``` + +3. Manually set cookie parameters in the JSON file of the session + +```json +{ + "__meta__": { + "about": "HTTPie session file", + "help": "https://httpie.org/doc#sessions", + "httpie": "2.2.0-dev" + }, + "auth": { + "password": null, + "type": null, + "username": null + }, + "cookies": { + "foo": { + "expires": null, + "path": "/", + "secure": false, + "value": "bar" + } + } +} +``` + +Cookies will be set in the session file with the priority specified above. +For example, a cookie set through the command line will overwrite a cookie of the same name stored in the session file. +If the server returns a `Set-Cookie` header with a cookie of the same name, the returned cookie will overwrite the preexisting cookie. + +Expired cookies are never stored. +If a cookie in a session file expires, it will be removed before sending a new request. +If the server expires an existing cookie, it will also be removed from the session file. + +## Config + +HTTPie uses a simple `config.json` file. +The file doesn’t exist by default but you can create it manually. + +### Config file directory + +To see the exact location for your installation, run `http --debug` and look for `config_dir` in the output. + +The default location of the configuration file on most platforms is `$XDG_CONFIG_HOME/httpie/config.json` (defaulting to `~/.config/httpie/config.json`). + +For backwards compatibility, if the directory `~/.httpie` exists, the configuration file there will be used instead. + +On Windows, the config file is located at `%APPDATA%\httpie\config.json`. + +The config directory can be changed by setting the `$HTTPIE_CONFIG_DIR` environment variable: + +```bash +$ export HTTPIE_CONFIG_DIR=/tmp/httpie +$ http pie.dev/get +``` + +### Configurable options + +Currently, HTTPie offers a single configurable option: + +#### `default_options` + +An `Array` (by default empty) of default options that should be applied to every invocation of HTTPie. + +For instance, you can use this config option to change your default color theme: + +```bash +$ cat ~/.config/httpie/config.json +``` + +```json +{ + "default_options": [ + "--style=fruity" + ] +} +``` + +Technically, it is possible to include any HTTPie options in there. +However, it is not recommended to modify the default behavior in a way that would break your compatibility with the wider world as that may become confusing. + +### Un-setting previously specified options + +Default options from the config file, or specified any other way, can be unset for a particular invocation via `--no-OPTION` arguments passed via the command line (e.g., `--no-style` or `--no-session`). + +## Scripting + +When using HTTPie from shell scripts, it can be handy to set the `--check-status` flag. +It instructs HTTPie to exit with an error if the HTTP status is one of `3xx`, `4xx`, or `5xx`. +The exit status will be `3` (unless `--follow` is set), `4`, or `5`, respectively. + +```bash +#!/bin/bash + +if http --check-status --ignore-stdin --timeout=2.5 HEAD pie.dev/get &> /dev/null; then + echo 'OK!' +else + case $? in + 2) echo 'Request timed out!' ;; + 3) echo 'Unexpected HTTP 3xx Redirection!' ;; + 4) echo 'HTTP 4xx Client Error!' ;; + 5) echo 'HTTP 5xx Server Error!' ;; + 6) echo 'Exceeded --max-redirects= redirects!' ;; + *) echo 'Other Error!' ;; + esac +fi +``` + +### Best practices + +The default behavior of automatically reading `stdin` is typically not desirable during non-interactive invocations. +You most likely want to use the `--ignore-stdin` option to disable it. + +It is a common *gotcha* that without this option HTTPie seemingly hangs. +What happens is that when HTTPie is invoked, for example, from a cron job, `stdin` is not connected to a terminal. +Therefore, the rules for [redirected input](#redirected-input) apply, i.e. HTTPie starts to read it expecting that the request body will be passed through. +And since there’s neither data nor `EOF`, it will get stuck. So unless you’re piping some data to HTTPie, the `--ignore-stdin` flag should be used in scripts. + +Also, it might be good to set a connection `--timeout` limit to prevent your program from hanging if the server never responds. + +## Meta + +### Interface design + +The syntax of the command arguments closely correspond to the actual HTTP requests sent over the wire. +It has the advantage that it’s easy to remember and read. +You can often translate an HTTP request to an HTTPie argument list just by inlining the request elements. +For example, compare this HTTP request: + +```http +POST /post HTTP/1.1 +Host: pie.dev +X-API-Key: 123 +User-Agent: Bacon/1.0 +Content-Type: application/x-www-form-urlencoded + +name=value&name2=value2 +``` + +with the HTTPie command that sends it: + +```bash +$ http -f POST pie.dev/post \ + X-API-Key:123 \ + User-Agent:Bacon/1.0 \ + name=value \ + name2=value2 +``` + +Notice that both the order of elements and the syntax are very similar, and that only a small portion of the command is used to control HTTPie and doesn’t directly correspond to any part of the request (here, it’s only `-f` asking HTTPie to send a form request). + +The two modes, `--pretty=all` (default for terminal) and `--pretty=none` (default for [redirected output](#redirected-output)), allow for both user-friendly interactive use and usage from scripts, where HTTPie serves as a generic HTTP client. + +In the future, the command line syntax and some of the `--OPTIONS` may change slightly, as HTTPie improves and new features are added. +All changes are recorded in the [change log](#change-log). + +### Community and Support + +HTTPie has the following community channels: + +- [GitHub Issues](https://github.com/jkbr/httpie/issues) for bug reports and feature requests +- [Discord server](https://httpie.io/chat) to ask questions, discuss features, and for general API development discussion +- [StackOverflow](https://stackoverflow.com) to ask questions (make sure to use the [httpie](https://stackoverflow.com/questions/tagged/httpie) tag) +- Twitter; where you can tweet directly to (and follow!) [@httpie](https://twitter.com/httpie) + +### Related projects + +#### Dependencies + +Under the hood, HTTPie uses these two amazing libraries: + +- [Requests](https://python-requests.org) — Python HTTP library for humans +- [Pygments](https://pygments.org/) — Python syntax highlighter + +#### HTTPie friends + +HTTPie plays exceptionally well with the following tools: + +- [http-prompt](https://github.com/httpie/http-prompt) — an interactive shell for HTTPie featuring autocomplete and command syntax highlighting +- [jq](https://stedolan.github.io/jq/) — CLI JSON processor that works great in conjunction with HTTPie + +Helpers to convert from other client tools: + +- [CurliPie](https://curlipie.now.sh/) help convert cURL command line to HTTPie command line + +#### Alternatives + +- [httpcat](https://github.com/jakubroztocil/httpcat) — a lower-level sister utility of HTTPie for constructing raw HTTP requests on the command line +- [curl](https://curl.haxx.se) — a "Swiss knife" command line tool and an exceptional library for transferring data with URLs. + +### Contributing + +See [CONTRIBUTING](https://github.com/httpie/httpie/blob/master/CONTRIBUTING.md). + +### Change log + +See [CHANGELOG](https://github.com/httpie/httpie/blob/master/CHANGELOG.md). + +### Artwork + +- Logo and branding by [HTTPie](https://httpie.io). +- [README Animation](https://raw.githubusercontent.com/httpie/httpie/master/httpie.gif) by [Allen Smith](https://github.com/loranallensmith). + +### Licence + +BSD-3-Clause: [LICENSE](https://github.com/httpie/httpie/blob/master/LICENSE). + +### Authors + +[Jakub Roztocil](https://roztocil.co) ([@jakubroztocil](https://twitter.com/jakubroztocil)) created HTTPie and [these fine people](https://github.com/httpie/httpie/AUTHORS.md) have contributed. diff --git a/setup.py b/setup.py index dca1d727..d841aa3a 100644 --- a/setup.py +++ b/setup.py @@ -8,7 +8,6 @@ import httpie # Note: keep requirements here to ease distributions packaging tests_require = [ - 'docutils', 'pytest', 'pytest-httpbin>=0.0.6', 'responses', @@ -20,6 +19,7 @@ dev_require = [ 'flake8-deprecated', 'flake8-mutable', 'flake8-tuple', + 'mdformat', 'pytest-cov', 'twine', 'wheel', @@ -55,7 +55,7 @@ extras_require = { def long_description(): - with open('README.rst', encoding='utf-8') as f: + with open('README.md', encoding='utf-8') as f: return f.read() @@ -64,7 +64,7 @@ setup( version=httpie.__version__, description=httpie.__doc__.strip(), long_description=long_description(), - long_description_content_type='text/x-rst', + long_description_content_type='text/markdown', url='https://httpie.org/', download_url=f'https://github.com/httpie/httpie/archive/{httpie.__version__}.tar.gz', author=httpie.__author__, diff --git a/tests/README.md b/tests/README.md new file mode 100644 index 00000000..d3e46091 --- /dev/null +++ b/tests/README.md @@ -0,0 +1,3 @@ +# HTTPie Test Suite + +Please see [CONTRIBUTING](https://github.com/httpie/httpie/blob/master/CONTRIBUTING.md) for contribution and testing guidelines. diff --git a/tests/README.rst b/tests/README.rst deleted file mode 100644 index ab7d518e..00000000 --- a/tests/README.rst +++ /dev/null @@ -1,8 +0,0 @@ -HTTPie Test Suite -================= - - -Please see `CONTRIBUTING`_. - - -.. _CONTRIBUTING: https://github.com/httpie/httpie/blob/master/CONTRIBUTING.rst diff --git a/tests/test_docs.py b/tests/test_docs.py index ef45d795..9a5afbf7 100644 --- a/tests/test_docs.py +++ b/tests/test_docs.py @@ -1,69 +1,35 @@ import os -import subprocess -from glob import glob -from pathlib import Path import pytest +from httpie.compat import is_windows from .utils import TESTS_ROOT +ROOT = TESTS_ROOT.parent SOURCE_DIRECTORIES = [ + 'docs', 'extras', 'httpie', 'tests', ] -def has_docutils(): - try: - # noinspection PyUnresolvedReferences,PyPackageRequirements - import docutils # noqa - return True - except ImportError: - return False +def md_filenames(): + yield from ROOT.glob('*.md') + for directory in SOURCE_DIRECTORIES: + yield from (ROOT / directory).glob('**/*.md') -def rst_filenames(): - cwd = os.getcwd() - os.chdir(TESTS_ROOT.parent) - try: - yield from glob('*.rst') - for directory in SOURCE_DIRECTORIES: - yield from glob(f'{directory}/**/*.rst', recursive=True) - finally: - os.chdir(cwd) - - -filenames = sorted(rst_filenames()) +filenames = sorted(md_filenames()) assert filenames -# HACK: hardcoded paths, venv should be irrelevant, etc. -# TODO: simplify by using the Python API instead of a subprocess -# then we wont’t need the paths. -VENV_BIN = Path(__file__).parent.parent / 'venv/bin' -VENV_PYTHON = VENV_BIN / 'python' -VENV_RST2PSEUDOXML = VENV_BIN / 'rst2pseudoxml.py' - - -@pytest.mark.skipif( - not VENV_RST2PSEUDOXML.exists(), - reason='docutils not installed', -) +@pytest.mark.skipif(is_windows and 'CI' in os.environ, + reason='Does not pass on GitHub.') @pytest.mark.parametrize('filename', filenames) -def test_rst_file_syntax(filename): - p = subprocess.Popen( - [ - VENV_PYTHON, - VENV_RST2PSEUDOXML, - '--report=1', - '--exit-status=1', - filename, - ], - stderr=subprocess.PIPE, - stdout=subprocess.PIPE, - shell=True, - ) - err = p.communicate()[1] - assert p.returncode == 0, err.decode() +def test_md_file_syntax(filename): + mdformat = pytest.importorskip('mdformat._cli') + args = ['--end-of-line', 'lf', '--number'] + err = f'Running "python -m mdformat {" ".join(args)} {filename}; git diff" should help.' + assert mdformat.run(args + ['--check', str(filename)]) == 0, err