Skip to content

Commit

Permalink
[KED-1409] Move ipython_loader from kedro.extras to tools (#448)
Browse files Browse the repository at this point in the history
  • Loading branch information
921kiyo committed Feb 25, 2020
1 parent 216ae61 commit 8276846
Show file tree
Hide file tree
Showing 8 changed files with 6 additions and 7 deletions.
2 changes: 1 addition & 1 deletion RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
* `kedro/contrib/decorators/memory_profiler.py` copied to `kedro/extras/decorators/memory_profiler.py`.
* `kedro/contrib/io/transformers/transformers.py` copied to `kedro/extras/transformers/time_profiler.py`.
* `kedro/contrib/colors/logging/color_logger.py` copied to `kedro/extras/logging/color_logger.py`.
* `extras/ipython_loader.py` copied to `kedro/extras/ipython/ipython_loader.py`.
* `extras/ipython_loader.py` copied to `tools/ipython/ipython_loader.py`.
* `kedro/contrib/io/cached/cached_dataset.py` copied to `kedro/io/cached_dataset.py`.
* `kedro/contrib/io/catalog_with_default/data_catalog_with_default.py` copied to `kedro/io/data_catalog_with_default.py`.
* `kedro/contrib/config/templated_config.py` copied to `kedro/config/templated_config.py`.
Expand Down
6 changes: 3 additions & 3 deletions docs/source/04_user_guide/11_ipython.md
Original file line number Diff line number Diff line change
Expand Up @@ -269,9 +269,9 @@ There are optional extra scripts that can help improve your Kedro experience for

### IPython loader

The script `kedro/extras/ipython/ipython_loader.py` helps to locate IPython startup directory and run all Python scripts in it when working with Jupyter notebooks and IPython sessions. It should work identically not just within a Kedro project, but also with any project that contains IPython startup scripts.
The script `tools/ipython/ipython_loader.py` helps to locate IPython startup directory and run all Python scripts in it when working with Jupyter notebooks and IPython sessions. It should work identically not just within a Kedro project, but also with any project that contains IPython startup scripts.

This script will automatically locate `.ipython/profile_default/startup` directory starting from the current working directory and going up the directory tree. If the directory was found, all Python scripts in it are be executed.
This script will automatically locate `.ipython/profile_default/startup` directory starting from the current working directory and going up the directory tree. If the directory was found, all Python scripts in it are executed.

> *Note:* This script will only run startup scripts from the first encountered `.ipython/profile_default/startup` directory. All consecutive `.ipython` directories higher up in the directory tree will be disregarded.
Expand All @@ -281,7 +281,7 @@ To install this script simply download it into your default IPython config direc

```bash
mkdir -p ~/.ipython/profile_default/startup
wget -O ~/.ipython/profile_default/startup/ipython_loader.py https://raw.githubusercontent.com/quantumblacklabs/kedro/master/kedro/extras/ipython/ipython_loader.py
wget -O ~/.ipython/profile_default/startup/ipython_loader.py https://raw.githubusercontent.com/quantumblacklabs/kedro/master/tools/ipython/ipython_loader.py
```

#### Prerequisites
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,8 @@
from pathlib import Path

import pytest

from kedro.extras.ipython import ipython_loader
from kedro.extras.ipython.ipython_loader import locate_ipython_startup_dir
from tools.ipython import ipython_loader
from tools.ipython.ipython_loader import locate_ipython_startup_dir


@pytest.fixture
Expand Down
File renamed without changes.
File renamed without changes.
Empty file added tools/ipython/__init__.py
Empty file.
File renamed without changes.

0 comments on commit 8276846

Please sign in to comment.