├── .gitignore ├── README.md ├── main.py ├── panelApps ├── app1.py └── pn_app.py └── templates └── base.html /.gitignore: -------------------------------------------------------------------------------- 1 | ## Ignore Visual Studio temporary files, build results, and 2 | ## files generated by popular Visual Studio add-ons. 3 | ## 4 | ## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore 5 | 6 | # User-specific files 7 | *.rsuser 8 | *.suo 9 | *.user 10 | *.userosscache 11 | *.sln.docstates 12 | 13 | # User-specific files (MonoDevelop/Xamarin Studio) 14 | *.userprefs 15 | 16 | # Mono auto generated files 17 | mono_crash.* 18 | 19 | # Build results 20 | [Dd]ebug/ 21 | [Dd]ebugPublic/ 22 | [Rr]elease/ 23 | [Rr]eleases/ 24 | x64/ 25 | x86/ 26 | [Aa][Rr][Mm]/ 27 | [Aa][Rr][Mm]64/ 28 | bld/ 29 | [Bb]in/ 30 | [Oo]bj/ 31 | [Ll]og/ 32 | [Ll]ogs/ 33 | 34 | # Visual Studio 2015/2017 cache/options directory 35 | .vs/ 36 | # Uncomment if you have tasks that create the project's static files in wwwroot 37 | #wwwroot/ 38 | 39 | # Visual Studio 2017 auto generated files 40 | Generated\ Files/ 41 | 42 | # MSTest test Results 43 | [Tt]est[Rr]esult*/ 44 | [Bb]uild[Ll]og.* 45 | 46 | # NUnit 47 | *.VisualState.xml 48 | TestResult.xml 49 | nunit-*.xml 50 | 51 | # Build Results of an ATL Project 52 | [Dd]ebugPS/ 53 | [Rr]eleasePS/ 54 | dlldata.c 55 | 56 | # Benchmark Results 57 | BenchmarkDotNet.Artifacts/ 58 | 59 | # .NET Core 60 | project.lock.json 61 | project.fragment.lock.json 62 | artifacts/ 63 | 64 | # StyleCop 65 | StyleCopReport.xml 66 | 67 | # Files built by Visual Studio 68 | *_i.c 69 | *_p.c 70 | *_h.h 71 | *.ilk 72 | *.meta 73 | *.obj 74 | *.iobj 75 | *.pch 76 | *.pdb 77 | *.ipdb 78 | *.pgc 79 | *.pgd 80 | *.rsp 81 | *.sbr 82 | *.tlb 83 | *.tli 84 | *.tlh 85 | *.tmp 86 | *.tmp_proj 87 | *_wpftmp.csproj 88 | *.log 89 | *.vspscc 90 | *.vssscc 91 | .builds 92 | *.pidb 93 | *.svclog 94 | *.scc 95 | 96 | # Chutzpah Test files 97 | _Chutzpah* 98 | 99 | # Visual C++ cache files 100 | ipch/ 101 | *.aps 102 | *.ncb 103 | *.opendb 104 | *.opensdf 105 | *.sdf 106 | *.cachefile 107 | *.VC.db 108 | *.VC.VC.opendb 109 | 110 | # Visual Studio profiler 111 | *.psess 112 | *.vsp 113 | *.vspx 114 | *.sap 115 | 116 | # Visual Studio Trace Files 117 | *.e2e 118 | 119 | # TFS 2012 Local Workspace 120 | $tf/ 121 | 122 | # Guidance Automation Toolkit 123 | *.gpState 124 | 125 | # ReSharper is a .NET coding add-in 126 | _ReSharper*/ 127 | *.[Rr]e[Ss]harper 128 | *.DotSettings.user 129 | 130 | # TeamCity is a build add-in 131 | _TeamCity* 132 | 133 | # DotCover is a Code Coverage Tool 134 | *.dotCover 135 | 136 | # AxoCover is a Code Coverage Tool 137 | .axoCover/* 138 | !.axoCover/settings.json 139 | 140 | # Visual Studio code coverage results 141 | *.coverage 142 | *.coveragexml 143 | 144 | # NCrunch 145 | _NCrunch_* 146 | .*crunch*.local.xml 147 | nCrunchTemp_* 148 | 149 | # MightyMoose 150 | *.mm.* 151 | AutoTest.Net/ 152 | 153 | # Web workbench (sass) 154 | .sass-cache/ 155 | 156 | # Installshield output folder 157 | [Ee]xpress/ 158 | 159 | # DocProject is a documentation generator add-in 160 | DocProject/buildhelp/ 161 | DocProject/Help/*.HxT 162 | DocProject/Help/*.HxC 163 | DocProject/Help/*.hhc 164 | DocProject/Help/*.hhk 165 | DocProject/Help/*.hhp 166 | DocProject/Help/Html2 167 | DocProject/Help/html 168 | 169 | # Click-Once directory 170 | publish/ 171 | 172 | # Publish Web Output 173 | *.[Pp]ublish.xml 174 | *.azurePubxml 175 | # Note: Comment the next line if you want to checkin your web deploy settings, 176 | # but database connection strings (with potential passwords) will be unencrypted 177 | *.pubxml 178 | *.publishproj 179 | 180 | # Microsoft Azure Web App publish settings. Comment the next line if you want to 181 | # checkin your Azure Web App publish settings, but sensitive information contained 182 | # in these scripts will be unencrypted 183 | PublishScripts/ 184 | 185 | # NuGet Packages 186 | *.nupkg 187 | # NuGet Symbol Packages 188 | *.snupkg 189 | # The packages folder can be ignored because of Package Restore 190 | **/[Pp]ackages/* 191 | # except build/, which is used as an MSBuild target. 192 | !**/[Pp]ackages/build/ 193 | # Uncomment if necessary however generally it will be regenerated when needed 194 | #!**/[Pp]ackages/repositories.config 195 | # NuGet v3's project.json files produces more ignorable files 196 | *.nuget.props 197 | *.nuget.targets 198 | 199 | # Microsoft Azure Build Output 200 | csx/ 201 | *.build.csdef 202 | 203 | # Microsoft Azure Emulator 204 | ecf/ 205 | rcf/ 206 | 207 | # Windows Store app package directories and files 208 | AppPackages/ 209 | BundleArtifacts/ 210 | Package.StoreAssociation.xml 211 | _pkginfo.txt 212 | *.appx 213 | *.appxbundle 214 | *.appxupload 215 | 216 | # Visual Studio cache files 217 | # files ending in .cache can be ignored 218 | *.[Cc]ache 219 | # but keep track of directories ending in .cache 220 | !?*.[Cc]ache/ 221 | 222 | # Others 223 | ClientBin/ 224 | ~$* 225 | *~ 226 | *.dbmdl 227 | *.dbproj.schemaview 228 | *.jfm 229 | *.pfx 230 | *.publishsettings 231 | orleans.codegen.cs 232 | 233 | # Including strong name files can present a security risk 234 | # (https://github.com/github/gitignore/pull/2483#issue-259490424) 235 | #*.snk 236 | 237 | # Since there are multiple workflows, uncomment next line to ignore bower_components 238 | # (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) 239 | #bower_components/ 240 | 241 | # RIA/Silverlight projects 242 | Generated_Code/ 243 | 244 | # Backup & report files from converting an old project file 245 | # to a newer Visual Studio version. Backup files are not needed, 246 | # because we have git ;-) 247 | _UpgradeReport_Files/ 248 | Backup*/ 249 | UpgradeLog*.XML 250 | UpgradeLog*.htm 251 | ServiceFabricBackup/ 252 | *.rptproj.bak 253 | 254 | # SQL Server files 255 | *.mdf 256 | *.ldf 257 | *.ndf 258 | 259 | # Business Intelligence projects 260 | *.rdl.data 261 | *.bim.layout 262 | *.bim_*.settings 263 | *.rptproj.rsuser 264 | *- [Bb]ackup.rdl 265 | *- [Bb]ackup ([0-9]).rdl 266 | *- [Bb]ackup ([0-9][0-9]).rdl 267 | 268 | # Microsoft Fakes 269 | FakesAssemblies/ 270 | 271 | # GhostDoc plugin setting file 272 | *.GhostDoc.xml 273 | 274 | # Node.js Tools for Visual Studio 275 | .ntvs_analysis.dat 276 | node_modules/ 277 | 278 | # Visual Studio 6 build log 279 | *.plg 280 | 281 | # Visual Studio 6 workspace options file 282 | *.opt 283 | 284 | # Visual Studio 6 auto-generated workspace file (contains which files were open etc.) 285 | *.vbw 286 | 287 | # Visual Studio LightSwitch build output 288 | **/*.HTMLClient/GeneratedArtifacts 289 | **/*.DesktopClient/GeneratedArtifacts 290 | **/*.DesktopClient/ModelManifest.xml 291 | **/*.Server/GeneratedArtifacts 292 | **/*.Server/ModelManifest.xml 293 | _Pvt_Extensions 294 | 295 | # Paket dependency manager 296 | .paket/paket.exe 297 | paket-files/ 298 | 299 | # FAKE - F# Make 300 | .fake/ 301 | 302 | # CodeRush personal settings 303 | .cr/personal 304 | 305 | # Python Tools for Visual Studio (PTVS) 306 | __pycache__/ 307 | *.pyc 308 | 309 | # Cake - Uncomment if you are using it 310 | # tools/** 311 | # !tools/packages.config 312 | 313 | # Tabs Studio 314 | *.tss 315 | 316 | # Telerik's JustMock configuration file 317 | *.jmconfig 318 | 319 | # BizTalk build output 320 | *.btp.cs 321 | *.btm.cs 322 | *.odx.cs 323 | *.xsd.cs 324 | 325 | # OpenCover UI analysis results 326 | OpenCover/ 327 | 328 | # Azure Stream Analytics local run output 329 | ASALocalRun/ 330 | 331 | # MSBuild Binary and Structured Log 332 | *.binlog 333 | 334 | # NVidia Nsight GPU debugger configuration file 335 | *.nvuser 336 | 337 | # MFractors (Xamarin productivity tool) working folder 338 | .mfractor/ 339 | 340 | # Local History for Visual Studio 341 | .localhistory/ 342 | 343 | # BeatPulse healthcheck temp database 344 | healthchecksdb 345 | 346 | # Backup folder for Package Reference Convert tool in Visual Studio 2017 347 | MigrationBackup/ 348 | 349 | # Ionide (cross platform F# VS Code tools) working folder 350 | .ionide/ 351 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # FastAPI-Panel 2 | A minimum reproducible repository for embedding panel in FastAPI 3 | 4 | Follow either [This Tutorial](https://hackmd.io/ileoi_9YT6eEm27hbxTzmA?view) 5 | or 6 | These steps below ↓↓↓ 7 | 8 | 1. Clone the repository (git clone https://github.com/t-houssian/FastAPI-Panel.git) 9 | 2. Install the needed libraries 10 | `pip install "fastapi[all]"` 11 | `pip install panel` 12 | 4. Run the app using `uvicorn main:app --reload` 13 | 5. Open the app at `http://127.0.0.1:8000/` 14 | 15 | That's it! You can change, modify, or add to the code in any way you'd like. 16 | 17 | ## Multiple Apps 18 | This is just a basic single app example. To run multiple apps you will need to do the following: 19 | 1. Create a new file in your panelApps directory (ex. `app2.py`) and add your new app code. 20 | 2. Create another pn_app file in your panelApps directory (ex. `pn_app2.py`) That might look something like this: 21 | ```python 22 | import panel as pn 23 | 24 | from .app2 import SineWave2 25 | 26 | def createApp2(): 27 | sw = SineWave() 28 | return pn.Row(sw.param, sw.plot).servable() 29 | ``` 30 | 3. Create a new html template (ex. app2.html) with the same contents as base.html 31 | 4. Import your new app in main.py `from panelApps.pn_app import createApp2` 32 | 5. Add your new app to the dictionary in pn.serve 33 | ```python 34 | {'/app': createApp, '/app2': createApp2} 35 | ``` 36 | 7. Add a new async function to rout your new app (The bottom of `main.py` should look something like this now): 37 | ```python 38 | @app.get("/") 39 | async def bkapp_page(request: Request): 40 | script = server_document('http://127.0.0.1:5000/app') 41 | return templates.TemplateResponse("base.html", {"request": request, "script": script}) 42 | 43 | @app.get("/app2") 44 | async def bkapp_page2(request: Request): 45 | script = server_document('http://127.0.0.1:5000/app2') 46 | return templates.TemplateResponse("app2.html", {"request": request, "script": script}) 47 | 48 | pn.serve({'/app': createApp, '/app2': createApp2}, 49 | port=5000, allow_websocket_origin=["127.0.0.1:8000"], 50 | address="127.0.0.1", show=False) 51 | ``` 52 | 3. Open the additional app at `http://127.0.0.1:8000/app2` 53 | -------------------------------------------------------------------------------- /main.py: -------------------------------------------------------------------------------- 1 | import panel as pn 2 | from bokeh.embed import server_document 3 | from fastapi import FastAPI, Request 4 | from fastapi.templating import Jinja2Templates 5 | 6 | from panelApps.pn_app import createApp 7 | 8 | app = FastAPI() 9 | templates = Jinja2Templates(directory="templates") 10 | 11 | 12 | @app.get("/") 13 | async def bkapp_page(request: Request): 14 | script = server_document('http://127.0.0.1:5000/app') 15 | return templates.TemplateResponse("base.html", {"request": request, "script": script}) 16 | 17 | pn.serve({'/app': createApp}, 18 | port=5000, allow_websocket_origin=["127.0.0.1:8000"], 19 | address="127.0.0.1", show=False) 20 | -------------------------------------------------------------------------------- /panelApps/app1.py: -------------------------------------------------------------------------------- 1 | import numpy as np 2 | import param 3 | from bokeh.models import ColumnDataSource 4 | from bokeh.plotting import figure 5 | 6 | 7 | class SineWave(param.Parameterized): 8 | offset = param.Number(default=0.0, bounds=(-5.0, 5.0)) 9 | amplitude = param.Number(default=1.0, bounds=(-5.0, 5.0)) 10 | phase = param.Number(default=0.0, bounds=(0.0, 2 * np.pi)) 11 | frequency = param.Number(default=1.0, bounds=(0.1, 5.1)) 12 | N = param.Integer(default=200, bounds=(0, None)) 13 | x_range = param.Range(default=(0, 4 * np.pi), bounds=(0, 4 * np.pi)) 14 | y_range = param.Range(default=(-2.5, 2.5), bounds=(-10, 10)) 15 | 16 | def __init__(self, **params): 17 | super(SineWave, self).__init__(**params) 18 | x, y = self.sine() 19 | self.cds = ColumnDataSource(data=dict(x=x, y=y)) 20 | self.plot = figure(plot_height=400, plot_width=400, 21 | tools="crosshair, pan, reset, save, wheel_zoom", 22 | x_range=self.x_range, y_range=self.y_range) 23 | self.plot.line('x', 'y', source=self.cds, line_width=3, line_alpha=0.6) 24 | 25 | @param.depends('N', 'frequency', 'amplitude', 'offset', 'phase', 'x_range', 'y_range', watch=True) 26 | def update_plot(self): 27 | x, y = self.sine() 28 | self.cds.data = dict(x=x, y=y) 29 | self.plot.x_range.start, self.plot.x_range.end = self.x_range 30 | self.plot.y_range.start, self.plot.y_range.end = self.y_range 31 | 32 | def sine(self): 33 | x = np.linspace(0, 4 * np.pi, self.N) 34 | y = self.amplitude * np.sin(self.frequency * x + self.phase) + self.offset 35 | return x, y -------------------------------------------------------------------------------- /panelApps/pn_app.py: -------------------------------------------------------------------------------- 1 | import panel as pn 2 | 3 | from .app1 import SineWave 4 | 5 | def createApp(): 6 | sw = SineWave() 7 | return pn.Row(sw.param, sw.plot).servable() -------------------------------------------------------------------------------- /templates/base.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Panel in FastAPI: sliders 5 | 6 | 7 | {{ script|safe }} 8 | 9 | --------------------------------------------------------------------------------