posit-dev / posit-dev/py-shiny

Support binding to unix domain sockets

Open Beginner friendly
#1,850 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

needs-triage
Dominant language
Python
Stars
1.8k
Forks
135
Avg merge
2d 18h
Merged PRs (30d)
21

Description

It would be nice if shiny run would expose a cli option to bind to unix domain sockets instead of tcp ports.
uvicorn already supports this via the --uds flag.

This already works in python (as run_app() passes **kwargs on to uvicorn.run()):

from shiny import run_app

run_app("app:app", uds="/tmp/shiny.sock")

But in the shiny run cli, additional arguments are not allowed.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the shiny run CLI entry point and compare its accepted options with the arguments passed by run_app() to uvicorn.run(). Check how uvicorn's --uds option is represented and add equivalent CLI support, with completion shown by invoking shiny run --help and binding an app to a Unix socket.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
62/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.