Skip to content

Commit 634e3c3

Browse files
authored
Merge pull request #981 from Labelbox/vbrodsky-contrib-jupyter
Update CONTRIB.md
2 parents e7eaed3 + 910afc9 commit 634e3c3

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

CONTRIB.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,4 +63,20 @@ Each release should follow the following steps:
6363
6. This will kick off a Github Actions workflow that will:
6464
- Build the library in the [standard way](https://packaging.python.org/tutorials/packaging-projects/#generating-distribution-archives)
6565
- Upload the distribution archives in the [standard way](https://packaging.python.org/tutorials/packaging-projects/#uploading-the-distribution-archives)
66-
with credentials for the `labelbox` PyPI user.
66+
- with credentials for the `labelbox` PyPI user.
67+
68+
## Running Jupyter Notebooks
69+
70+
We have plenty of good samples in the _examples_ directory and using them for testing can help us increase our productivity. One way to use jupyter notebooks is to run the jupyter server locally (another way is to use a VSC plugin, not documented here). It works really fast.
71+
72+
Make sure your notebook will use your source code:
73+
1. `ipython profile create`
74+
2. `ipython locate` - will show where the config file is. This is the config file used by the jupyter server, since it runs via ipython
75+
3. Open the file (this should be ipython_config.py and it is usually located in ~/.ipython/profile_default) and add the following line of code:
76+
```
77+
c.InteractiveShellApp.exec_lines = [
78+
'import sys; sys.path.insert(0, "<labelbox-python root folder>")'
79+
]
80+
```
81+
4. Go to the root of your project and run `jupyter notebook` to start the server
82+

0 commit comments

Comments
 (0)