Allow serving REST APIs as part of panel serve

[philippjfr]

Allows serving using panel serve some_script.py some_notebook.ipynb --tranquilize to serve REST APIs alongside the panel apps. Automatically discovers any tranquilized functions.

import panel as pn

from tranquilizer import tranquilize

@tranquilize()
def order(cheese):
    '''I'd like to buy some cheese!'''
    return {'response':"I'm afraid we're fresh out of {}, Sir.".format(cheese)}

pn.panel("# A panel app").servable()

e.g. this will serve the Panel app on http://localhost:5006/ and the REST API on http://localhost:5006/rest/order.

[codecov]

Codecov Report

Merging #1164 into master will decrease coverage by 0.57%.
The diff coverage is 26.25%.

@@            Coverage Diff             @@
##           master    #1164      +/-   ##
==========================================
- Coverage   86.27%   85.70%   -0.58%     
==========================================
  Files         143      144       +1     
  Lines       15786    15932     +146     
==========================================
+ Hits        13620    13654      +34     
- Misses       2166     2278     +112     

Impacted Files	Coverage Δ
panel/io/state.py	44.58% <20.37%> (-12.68%)	⬇️
panel/io/rest.py	26.96% <26.96%> (ø)
panel/command/serve.py	19.10% <28.57%> (+1.76%)	⬆️
panel/util.py	82.08% <100.00%> (+0.27%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 844c883...5dd78de. Read the comment docs.

[jlstevens]

This is great, thanks! I'll now check out this branch and test it...

[MarcSkovMadsen]

As far as I can see this supports

• parameters: like ?cheese=goatcheese ?
• get, post, put, delete requests?
• open api documentation?

If possible it would be so great if this supported

• serving csv and xlsx files as well.

and the documentation hinted at how to use this in practice using serializers etc.

I know I'm hoping for a lot. :-)

I've added a feature request to tranquilizer for serving csv, xlsx and parquet files ContinuumIO/tranquilizer#20.

[philippjfr]

I think for file serving we can easily add a simple static file request handler rather than building that on Tranquilizer or some other REST API.

[mattpap]

tranquilized functions

Is this a well defined term? Seeing just the title of this PR I didn't have any idea what to expect from its contents. I would use well known and defined terms like REST API across the board, and leave the name of the library as an implementation detail. So on the command like I would just use something along --allow-rest-apis or --serve-rest.

[philippjfr]

Yeah, I hear you, we're still iterating on what we actually want to support and this PR was mostly a prototype for a client.

[MarcSkovMadsen]

@philippjfr . I would like to serve some static files like sphinx documentation, some Angular .js files or similar. But the most important is actually to serve dynamic data in csv, xlsx and parquet format.

My primary use case is creating a dashboard and when the user gets to a dead end in the dashboard/ wants more she can get a link to the exact data in the plot, table or similar depending on the state of the app/ the value of sliders, dropdowns etc. She can use the link to download the data here and now. But also store or share the link. Or use PowerQuery in excel to setup a permanent link. Build her own small Panel app using Pandas and use the link to get the data etc.

Dynamic, shareable links are powerfull.

[philippjfr]

I understand that's a very different thing from a REST API though and is already covered by this issue of yours: #1118

[jbednar]

Looks great to me!

[JuliaS92]

Hi @philippjfr, as far as I understand this was part of the 0.10.0 release. Could you please provide an updated minimal example of how to use this? I tried the code snippet from the top of this thread and neither panel version 0.10.0, nor 0.10.3 accepted the --tranquilize option and it seems there are several --rest.. options added instead.

UPDATE: I just found the example in the version blog, so just for reference if anybody else looks for this here:
http://blog.holoviz.org/panel_0.10.0.html#Tranquilizer-REST-Provider