Skip to main content

ipython magic tool to send HTTP requests in a cell of notebooks

Project description

# Jest

Jest is a IPython magic tool to make us one or more HTTP request(s) in a cell.

## How it works

```
$ pip install pyjest
```

## Examples

Please take a look at the `examples` folder about how Jest can be used in a Jupyter notebook in more detail. The snippets below represent a sequence of three cells each of which shows how we can construct a jest call along with required fields for two HTTP calls in one run.

```
[1] consumes = [
dict(original_keyword='iphone'),
dict(original_keyword='phone')
]
```

The `consumes` variable holds a list of dictionary. Two different items will be used while jesting a request with a request body.

```
[2] %%jest --var responses --params consumes

{
"url": "http://localhost:8080/path",
"request": "post",
"body": {
"field": "@original_keyword",
"field": 1
},
"headers": {
"Content-Type": "application/json",
"Authorization": "Bearer ASDASADAS",
"Cookie": "auth_cookie=ASDADASDA"
}
}
```

Jest saves the response in to the `responses` field. We use `--params` to add that Jest will use it to load data from. The request body references a field name with suffix `@`. So that Jest understands that the referenced field must be in each item of `consumes`.

```
len(responses) # 2 for each item of `consumes`
```

After having a successful request, we can react the result via `responses`.

## License

MIT


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyjest-0.0.3.tar.gz (4.8 kB view details)

Uploaded Source

Built Distribution

pyjest-0.0.3-py3-none-any.whl (5.5 kB view details)

Uploaded Python 3

File details

Details for the file pyjest-0.0.3.tar.gz.

File metadata

  • Download URL: pyjest-0.0.3.tar.gz
  • Upload date:
  • Size: 4.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.7.8

File hashes

Hashes for pyjest-0.0.3.tar.gz
Algorithm Hash digest
SHA256 dff61593bbd5b013e1e875507d7208bc43d857d760b747fd1cd5444cf90c1ddb
MD5 7f636629e1b95d4f889c581b749bfd5d
BLAKE2b-256 b9ca78701be0b2e1f44240431741e79d8e55e79917a8005df18c049dfa29b110

See more details on using hashes here.

File details

Details for the file pyjest-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: pyjest-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 5.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.7.8

File hashes

Hashes for pyjest-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 d501da1a80761dd0cc14260926888ace18e129b3c3fa2a335024e932e21a057d
MD5 308cf96f4671a7a7e4be6e9a81eff93e
BLAKE2b-256 e5b6cba13a7a4af036fef05a52132ddd4d3d39fb09f4d0929c13890e68942e80

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page