Skip to content

Commit 7a80c21

Browse files
committed
Add binder links to README and echo commands during build
1 parent 9439f60 commit 7a80c21

File tree

2 files changed

+18
-8
lines changed

2 files changed

+18
-8
lines changed

README.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
# Text Extensions for Pandas
33

44
[![Documentation Status](https://readthedocs.org/projects/text-extensions-for-pandas/badge/?version=latest)](https://text-extensions-for-pandas.readthedocs.io/en/latest/?badge=latest)
5+
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/frreiss/tep-fred/branch-binder?urlpath=lab/tree/notebooks)
6+
57

68
Natural language processing support for Pandas dataframes.
79

@@ -61,10 +63,19 @@ of this repository to the front of `sys.path`.
6163

6264
## Documentation
6365

64-
For examples of how to use the library, take a look at the notebooks in
65-
[this directory](https://github.com/CODAIT/text-extensions-for-pandas/tree/master/notebooks).
66+
For examples of how to use the library, take a look at the **example notebooks** in
67+
[this directory](https://github.com/CODAIT/text-extensions-for-pandas/tree/master/notebooks). You can try out these notebooks on [Binder](https://mybinder.org/) by navigating to [https://mybinder.org/v2/gh/frreiss/tep-fred/branch-binder?urlpath=lab/tree/notebooks](https://mybinder.org/v2/gh/frreiss/tep-fred/branch-binder?urlpath=lab/tree/notebooks)
68+
69+
To run the notebooks on your local machine, follow the following steps:
70+
71+
1. Install [Anaconda](https://docs.anaconda.com/anaconda/install/) or [Miniconda](https://docs.conda.io/en/latest/miniconda.html).
72+
1. Check out a copy of this repository.
73+
1. Use the script `env.sh` to set up an Anaconda environment for running the code in this repository.
74+
1. Type `jupyter lab` from the root of your local source tree to start a [JupyterLab](https://jupyterlab.readthedocs.io/en/stable/) environment.
75+
1. Navigate to the `notebooks` directory and choose any of the notebooks there
76+
6677

67-
API documentation can be found at [https://readthedocs.org/projects/text-extensions-for-pandas/](https://readthedocs.org/projects/text-extensions-for-pandas/).
78+
**API documentation** can be found at [https://readthedocs.org/projects/text-extensions-for-pandas/](https://readthedocs.org/projects/text-extensions-for-pandas/).
6879

6980

7081
## Contents of this repository
@@ -83,11 +94,7 @@ API documentation can be found at [https://readthedocs.org/projects/text-extensi
8394
cover complex end-to-end NLP use cases (work in progress).
8495

8596

86-
## Instructions to run a demo notebook
87-
1. Check out a copy of this repository
88-
1. (optional) Use the script `env.sh` to set up an Anaconda environment for running the code in this repository.
89-
1. Type `jupyter lab` from the root of your local source tree to start a [JupyterLab](https://jupyterlab.readthedocs.io/en/stable/) environment.
90-
1. Navigate to the `notebooks` directory and choose any of the notebooks there
97+
## Instructions to run a demo notebook locally
9198

9299

93100
## Contributing

binder/postBuild

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# Post-build script for binder/repo2docker environment setup.
22

3+
# Log commands
4+
set -ex
5+
36
# Install additional packages beyond those in requirements.txt so that the
47
# JupyterLab instance will be able to run all of the NLP library integrations.
58
pip install -r config/dev_reqs.txt

0 commit comments

Comments
 (0)