Skip to content
This repository has been archived by the owner on Dec 5, 2024. It is now read-only.

Commit

Permalink
more in the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Carreau committed Jun 19, 2017
1 parent fde7601 commit dc90d2d
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,30 @@ $ ipython -c 'import disp; disp.uninstall()'

## Supported objects

the following objects will gain superpowers:
The following objects will gain superpowers automatically:

- `pyspark.context:SparkContext`
- `pyspark.sql:SparkSession`

The followings objects need to be explicitly register with
`disp.activate_builtins()` and will work only on Python 3.6 and later:

- types
- functions methods (and alike)
- modules

The following objects need to be explicitly activated individually for each
type with `disp.activate_for(instance)`:

- requests.models.Response (Python 3.6+ only)

A couple of other objects are secretly available on Python 3.6, but are still
unstable so-far (dig through the source).

## Example

See our [example notebook](http://nbviewer.jupyter.org/github/ipython/disp/blob/master/example/Disp-Example-builtins.ipynb)

## Do you support more objects?

Do you want to submit a Pull Request? We'll probably accept it. 🤓
Expand Down

0 comments on commit dc90d2d

Please sign in to comment.