id       = "streamlit"
name     = "Streamlit"
homepage = "https://streamlit.io"
description = "A faster way to build and share data apps."
icon     = "SimpleIcons:streamlit"
executables   = ["streamlit"]

[dotfiles]

# https://docs.streamlit.io/develop/api-reference/configuration/config.toml —
# "Global" configuration is ~/.streamlit/config.toml (spelled
# %userprofile%/.streamlit/config.toml on Windows, which resolves to the same
# path), read alongside a ./.streamlit/config.toml that belongs to the
# repository rather than to the user. credentials.toml sits beside it:
# lib/streamlit/runtime/credentials.py resolves it with
# file_util.get_streamlit_file_path(), documented in lib/streamlit/file_util.py
# as returning "the full path to a file in ~/.streamlit".
paths = [
  "~/.streamlit/config.toml",
  "~/.streamlit/credentials.toml",
]

exclude = []

# The default of the `secrets.files` option on the same page is
# ["~/.streamlit/secrets.toml", "$CWD/.streamlit/secrets.toml"] — the global
# one is where the user writes API keys and database connection strings, so
# the whole file is a credential.
#
# credentials.toml is not one despite the name: credentials.py writes only
# `data = {"email": self.activation.email}`, the address the first run prompts
# for, and nothing else.
secret = ["~/.streamlit/secrets.toml"]

# No machine_lines: config.toml is theme, server and client preferences — the
# things a user wants on every machine. A [server] port or address is a
# deliberate choice rather than a fact about the host, so nothing here is
# stranded.

[commands]
format = 1
label = "Streamlit commands"
description = "Run a Streamlit app script. Config, cache and docs subcommands are left out."
quality = "ai-draft"
base = "fig:streamlit"
parser = { end_of_options = "--", interleave = "permute", long_equals = true, short_attached = true, short_bundles = false }

[[commands.source]]
id = "fig"
kind = "completion"
url = "https://github.com/withfig/autocomplete/blob/master/src/streamlit.ts"
license = "MIT"

[[commands.subcommand]]
path = ["run"]
label = "Run an app"
description = "Run a Python script as a Streamlit app."
parser = { end_of_options = "--", interleave = "permute", long_equals = true, short_attached = true, short_bundles = false }

[[commands.subcommand.source]]
id = "fig"
kind = "completion"
url = "https://github.com/withfig/autocomplete/blob/master/src/streamlit.ts"
license = "MIT"

[[commands.subcommand.field]]
id = "script"
label = "Python script"
type = "path"
position = 0
path = { kind = "file", role = "input", must_exist = true }
sources = ["fig"]

[[commands.subcommand.task]]
id = "run"
label = "Run script"
fields = ["script"]
required = ["script"]

[[commands.subcommand.group]]
id = "basic"
label = "Basic"
fields = ["script"]