Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/luozhijian/jupyterexcel
Jupyter Extension make notebooks as web api return Json for Excel to Call
https://github.com/luozhijian/jupyterexcel
addin excel excel-to-json excel-vba jupyter python
Last synced: about 2 months ago
JSON representation
Jupyter Extension make notebooks as web api return Json for Excel to Call
- Host: GitHub
- URL: https://github.com/luozhijian/jupyterexcel
- Owner: luozhijian
- License: mit
- Created: 2019-05-30T06:00:46.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-08-10T22:55:40.000Z (about 4 years ago)
- Last Synced: 2024-07-10T13:01:00.854Z (3 months ago)
- Topics: addin, excel, excel-to-json, excel-vba, jupyter, python
- Language: Python
- Size: 2.61 MB
- Stars: 18
- Watchers: 1
- Forks: 8
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - luozhijian/jupyterexcel - Jupyter Extension make notebooks as web api return Json for Excel to Call (Python)
README
## jupyterexcel Package
This is a python package to make Jupyter.ipynb file a web api with json result. You can call Jupyter from Excel Formula or Ribbon CallBack Functions
SourceCode in [JupyterExcel](https://github.com/luozhijian/jupyterexcel)
Before install, please download [JupyterExcelTesting.xlsm](https://github.com/luozhijian/jupyterexcel/blob/master/JupyterExcelTesting.xlsm) to try its formula function and excel ribbon. If you think it works, you can modify the url in the sheet to your jupyter page and save it as "Addin" file.
This Jupyter Excel web api can be connected with Excel addin which call this web api. Excel formula will generate a web api url and through winhttp to get json result. It now works Mac Excel by using [VBA-Web](https://github.com/VBA-tools/VBA-Web).
## Installation
pip install jupyterexcel
then run
jupyter serverextension enable --py jupyterexcel
## Server setting
Please follow config [jupyter server](https://jupyter-notebook.readthedocs.io/en/stable/public_server.html) or use command
```
jupyter notebook --generate-config
if the file alraady there, please do not override. Remember the file path
```
and change following values:
```
c.NotebookApp.token = 'ABCD' #now, it has to use token mode. In the url in Excel, if it is not token, it will cause page forward to ask password, the excel will not work
c.NotebookApp.allow_origin = '*' #allow any origin to access your server. You can ignore following 3 connections,if you connect only from local computer
c.NotebookApp.allow_remote_access = True #if you like to set to access from other computer
c.NotebookApp.ip = '0.0.0.0' #allow all ip address to connect to this instance
c.NotebookApp.iopub_data_rate_limit = 32000000 #it might be good to change to a high number, if you will pass out large amount of data. (bytes/sec) Maximum rate at which stream output can be sent on iopub before
```
## Example
The following screenshot shows the sample notebook file with a function sum. You can download TestingJupyter.ipynb or create your own. The following is an instance I hosted in google cloud platform, you can open and add a function of yours.
http://www.jupyterexcel.com:8888/Excel/TestingJupyter.ipynb?token=ABCD&functionname=sum&1=11&2=8&3=6
http://www.jupyterexcel.com:8888/notebooks/TestingJupyter.ipynb?token=ABCD please change 34.67.24.96 to your computer name or localhost
The following screenshot shows how excel Formula works.
The following screenshot Shows how Ribbon Call Back function works
## Future Development Plan
1. Make Excel client side more easier to use, such as generate Excel formula proxy
2. Able to support R, Julia ....
3. It might only support one notebook page
## Reference
read some code from [appmode](https://github.com/oschuett/appmode)