https://github.com/b3b/ipython-restmagic

HTTP REST magic for IPython
https://github.com/b3b/ipython-restmagic

http ipython jupyter python python-requests

Last synced: 16 days ago
JSON representation

HTTP REST magic for IPython

• Host: GitHub
• URL: https://github.com/b3b/ipython-restmagic
• Owner: b3b
• License: mit
• Created: 2018-09-06T11:02:59.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2021-11-08T18:31:04.000Z (almost 3 years ago)
• Last Synced: 2024-10-03T11:35:53.337Z (about 1 month ago)
• Topics: http, ipython, jupyter, python, python-requests
• Language: Python
• Size: 273 KB
• Stars: 7
• Watchers: 3
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
ipython-restmagic

=================

.. start-badges

.. image:: https://img.shields.io/pypi/v/restmagic.svg

    :target: https://pypi.python.org/pypi/restmagic

    :alt: Latest version on PyPi

.. image:: https://img.shields.io/pypi/pyversions/restmagic.svg

    :target: https://pypi.python.org/pypi/restmagic

    :alt: Supported Python versions

.. image:: https://github.com/b3b/ipython-restmagic/workflows/ci/badge.svg?branch=master

     :target: https://github.com/b3b/ipython-restmagic/actions?workflow=CI

     :alt: CI Status

.. image:: https://img.shields.io/travis/b3b/ipython-restmagic.svg

    :target: https://travis-ci.org/b3b/ipython-restmagic

    :alt: Travis-CI build status

.. image:: https://codecov.io/github/b3b/ipython-restmagic/coverage.svg?branch=master

    :target: https://codecov.io/github/b3b/ipython-restmagic?branch=master

    :alt: Code coverage Status

.. image:: https://mybinder.org/badge_logo.svg

    :target: https://mybinder.org/v2/gh/b3b/ipython-restmagic/master?filepath=examples/usage.ipynb

    :alt: Open examples in Binder

.. end-badges

`%%rest` :  IPython magic to execute HTTP requests.

:Code repository: https://github.com/b3b/ipython-restmagic

:Documentation: https://herethere.me/restmagic

:Changelog: https://github.com/b3b/ipython-restmagic/blob/master/CHANGELOG.rst

Usage

-----

.. code-block:: ipython

    In [1]: %load_ext restmagic

    In [2]: %%rest

       ...: POST https://httpbin.org/post

       ...: Content-Type: application/json

       ...: Authorization: Bearer $mytoken

       ...:

       ...: {

       ...:     "some": "data",

       ...:     "array here": [

       ...:         "item 1",

       ...:         "item 2"

       ...:     ]

       ...: }

    Out [2]: 

Installation

------------

Package can be installed from the PyPI by executing::

    pip install restmagic

Development version can be installed by executing::

    pip install git+https://github.com/b3b/ipython-restmagic

Package can be uninstalled by executing::

    pip uninstall restmagic

Related resources

-----------------

* `restclient.el `__ : HTTP REST client tool for Emacs

* `Make Jupyter/IPython Notebook even more magical with cell magic extensions! `__ : Nicolas Kruchten's talk from the PyCon Canada 2015

* `ipython-sql `__ : was used as an example of IPython magic

* `python-requests `__ : used for HTTP requests

* `requests-toolbelt `__ : used for HTTP sessions information dumping

* `jsonpath-rw `__ : used to extract parts of JSON responses

* `lxml `__ : used to extract parts of XML/HTML responses