Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/obfusk/convert-to-requests
convert-to-requests - convert curl/fetch command to python requests
https://github.com/obfusk/convert-to-requests
curl fetch requests
Last synced: 22 days ago
JSON representation
convert-to-requests - convert curl/fetch command to python requests
- Host: GitHub
- URL: https://github.com/obfusk/convert-to-requests
- Owner: obfusk
- License: gpl-3.0
- Created: 2022-12-12T14:03:51.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2022-12-14T12:46:59.000Z (almost 2 years ago)
- Last Synced: 2024-09-15T02:31:56.366Z (about 2 months ago)
- Topics: curl, fetch, requests
- Language: Python
- Homepage:
- Size: 68.4 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.txt
- License: LICENSE.GPLv3
Awesome Lists containing this project
README
[](https://github.com/obfusk/convert-to-requests/releases)
[](https://pypi.python.org/pypi/convert-to-requests)
[](https://pypi.python.org/pypi/convert-to-requests)
[](https://github.com/obfusk/convert-to-requests/actions?query=workflow%3ACI)
[](https://www.gnu.org/licenses/gpl-3.0.html)
# convert-to-requests
## convert curl/fetch command to python requests
Parse `curl` command (from "copy to cURL") or (w/ `--fetch`) `fetch` code (from
"copy to fetch") from stdin and either execute the request using
`requests.request()` (`exec` subcommand) or print Python code to do so (`code`
subcommand).
### curl
Get the code:
```bash
$ convert-to-requests code --pretty <<< "curl 'https://obfusk.ch' -H 'User-Agent: Mozilla/5.0'"
requests.request('GET', 'https://obfusk.ch', headers={
'User-Agent': 'Mozilla/5.0'
})
```
Execute the request:
```bash
$ convert-to-requests exec -v <<< "curl 'https://obfusk.ch' -H 'User-Agent: Mozilla/5.0'" | head -2
GET https://obfusk.ch headers={'User-Agent': 'Mozilla/5.0'} data=None
```
POST works too:
```bash
$ convert-to-requests code <<< "curl 'https://example.com' -H 'User-Agent: Mozilla/5.0' -H 'Accept: application/json' -X POST --data-raw foo"
requests.request('POST', 'https://example.com', headers={'User-Agent': 'Mozilla/5.0', 'Accept': 'application/json'}, data=b'foo')
```
### fetch
```bash
$ convert-to-requests --fetch code <<'END'
fetch("https://example.com", {
"headers": {
"accept": "application/json"
},
"body": null,
"method": "GET",
"mode": "cors",
"credentials": "omit"
});
END
Warning: ignoring mode=
Warning: ignoring credentials=
requests.request('GET', 'https://example.com', headers={'accept': 'application/json'})
```
## Python API
```python
>>> from convert_to_requests import curl_to_requests, to_python_code
>>> req = curl_to_requests(r"curl 'https://example.com' -X POST --data-raw $'\'foo\''")
>>> req
RequestData(method='POST', url='https://example.com', headers={}, data=b"'foo'", ignored=[])
>>> print(to_python_code(req.method, req.url, req.headers, req.data))
requests.request('POST', 'https://example.com', headers={}, data=b"'foo'")
>>> print(req.code()) # shorter alternative
requests.request('POST', 'https://example.com', headers={}, data=b"'foo'")
```
```python
>>> import requests
>>> r = requests.request(req.method, req.url, headers=req.headers, data=req.data)
>>> r.raise_for_status()
>>> print(r.text, end="")
[...]
>>> print(req.exec().text, end="") # shorter alternative
[...]
```
```python
>>> from convert_to_requests import fetch_to_requests, to_python_code
>>> req = fetch_to_requests('''fetch("https://example.com", {"headers": {}, "method": "POST", "body": "'foo'"});''')
>>> req
RequestData(method='POST', url='https://example.com', headers={}, data=b"'foo'", ignored=[])
>>> print(to_python_code(req.method, req.url, req.headers, req.data))
requests.request('POST', 'https://example.com', headers={}, data=b"'foo'")
```
```python
>>> from convert_to_requests import parse_dollar_string, split_curl_command
>>> parse_dollar_string(r"$'\'foo\''")
("'foo'", '')
>>> split_curl_command(r''' curl https://example.com -H $'foo: \'bar\'' ''')
('curl', 'https://example.com', '-H', "foo: 'bar'")
```
## CAVEATS
### fetch
Unfortunately, "copy as fetch" doesn't include cookies ("copy as Node.js fetch"
does).
Chromium doesn't include a `User-Agent` header in either.
## Installing
### Using pip
```bash
$ pip install convert-to-requests
```
NB: depending on your system you may need to use e.g. `pip3 --user`
instead of just `pip`.
### From git
NB: this installs the latest development version, not the latest
release.
```bash
$ git clone https://github.com/obfusk/convert-to-requests.git
$ cd convert-to-requests
$ pip install -e .
```
NB: you may need to add e.g. `~/.local/bin` to your `$PATH` in order
to run `convert-to-requests`.
To update to the latest development version:
```bash
$ cd convert-to-requests
$ git pull --rebase
```
## Dependencies
* Python >= 3.8 + requests.
### Debian/Ubuntu
```bash
$ apt install python3-requests
```
## License
[](https://www.gnu.org/licenses/gpl-3.0.html)