otty / apps

All apps/Poetry

Poetry

poetry

Python packaging and dependency management made easy.

Runs as poetry|macOS, Linux, Windows|python-poetry.org

Open form in Otty otty.toml

Sync rules

What travels, what stays, what never leaves

Poetry in your home directory Every rule on this page, by file

cache-dirvirtualenvs.path

Each machine keeps its own copy of these.

· auth.toml Never synced

· ~/Library/Caches/pypoetry/ Exclude

Only what the catalog names. A directory that syncs brings everything inside it except what is listed as excluded here.

apps/poetry/otty.tomlThe file this page is generated from

id = "poetry"

name = "Poetry"

homepage = "https://python-poetry.org"

description = "Python packaging and dependency management made easy."

icon = "theSVG:poetry"

executables = ["poetry"]

[dotfiles]

# https://python-poetry.org/docs/configuration/ — "config.toml" lives in

# ~/Library/Application Support/pypoetry on macOS, %APPDATA%\pypoetry on

# Windows and ~/.config/pypoetry on Unix, following the XDG spec: [appData].

# POETRY_CONFIG_DIR overrides the directory.

paths = ["[appData]/pypoetry/config.toml"]

# Same page: the cache directory defaults to ~/Library/Caches/pypoetry on

# macOS, %LOCALAPPDATA%\pypoetry on Windows and ~/.cache/pypoetry on Unix —

# [cacheHome]. It holds downloaded distributions and the virtualenvs Poetry

# creates.

exclude = ["[cacheHome]/pypoetry/"]

# https://python-poetry.org/docs/repositories/ — repository credentials

# (http-basic.*, pypi-token.*) go to the system keyring, but "if access to

# keyring fails or is unsupported, this will fall back to writing the password

# to the auth.toml file along with the username", and `poetry config

# keyring.enabled false` makes that the normal path. auth.toml sits in the same

# config directory as config.toml and is nothing but usernames, passwords and

# tokens.

secret = ["[appData]/pypoetry/auth.toml"]

# Read per command; no daemon holds it open.

side_effect = false

# cache-dir and virtualenvs.path are absolute paths into this machine's disk —

# the defaults above differ per platform, and a user who moves them points at a

# volume that exists on one machine only. Everything else in config.toml

# (virtualenvs.in-project, installer settings) is a preference that should

# travel.

# A user who moves them chose those volumes deliberately, so the values are kept

# for rebuilding this machine and never handed to another.

[[dotfiles.machine_lines]]

file = "[appData]/pypoetry/config.toml"

match = { key_path = ["cache-dir", "virtualenvs.path"] }

scope = "backup"

[commands]

format = 1

label = "Poetry"

description = "Create projects, add dependencies, install and run commands. Options whose completion data lacks a value type (such as --group and --name) are left out."

quality = "ai-draft"

base = "fig:poetry"

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/poetry.ts"

license = "MIT"

[[commands.subcommand]]

path = ["new"]

label = "New project"

[[commands.subcommand.source]]

id = "fig"

kind = "completion"

url = "https://github.com/withfig/autocomplete/blob/master/src/poetry.ts"

license = "MIT"

[[commands.subcommand.field]]

id = "path"

label = "Project path"

type = "path"

position = 0

path = { kind = "directory", role = "output" }

sources = ["fig"]

[[commands.subcommand.field]]

id = "src"

label = "Use src layout"

type = "boolean"

option = ["--src"]

sources = ["fig"]

[[commands.subcommand.task]]

id = "new"

label = "Create project"

fields = ["path", "src"]

required = ["path"]

[[commands.subcommand.group]]

id = "basic"

label = "Basic"

fields = ["path", "src"]

[[commands.subcommand]]

path = ["add"]

label = "Add dependencies"

[[commands.subcommand.source]]

id = "fig"

kind = "completion"

url = "https://github.com/withfig/autocomplete/blob/master/src/poetry.ts"

license = "MIT"

[[commands.subcommand.field]]

id = "packages"

label = "Packages"

type = "string"

position = 0

multiple = true

sources = ["fig"]

[[commands.subcommand.field]]

id = "optional"

label = "Optional dependency"

type = "boolean"

option = ["--optional"]

sources = ["fig"]

[[commands.subcommand.field]]

id = "editable"

label = "Editable (vcs/path)"

type = "boolean"

option = ["--editable"]

sources = ["fig"]

[[commands.subcommand.field]]

id = "allow_prereleases"

label = "Allow prereleases"

type = "boolean"

option = ["--allow-prereleases"]

sources = ["fig"]

[[commands.subcommand.field]]

id = "dry_run"

label = "Dry run"

type = "boolean"

option = ["--dry-run"]

sources = ["fig"]

[[commands.subcommand.field]]

id = "lock"

label = "Only update lockfile"

type = "boolean"

option = ["--lock"]

sources = ["fig"]

[[commands.subcommand.task]]

id = "add"

label = "Add"

fields = ["packages", "optional", "editable", "allow_prereleases", "dry_run", "lock"]

required = ["packages"]

[[commands.subcommand.task]]

id = "preview"

label = "Dry run"

set = { dry_run = [true] }

fields = ["packages", "dry_run"]

required = ["packages"]

[[commands.subcommand.group]]

id = "basic"

label = "Basic"

fields = ["packages", "optional", "editable", "allow_prereleases", "dry_run"]

[[commands.subcommand.group]]

id = "advanced"

label = "Advanced"

fields = ["lock"]

[[commands.subcommand]]

path = ["install"]

label = "Install dependencies"

[[commands.subcommand.source]]

id = "fig"

kind = "completion"

url = "https://github.com/withfig/autocomplete/blob/master/src/poetry.ts"

license = "MIT"

[[commands.subcommand.field]]

id = "no_root"

label = "Skip the root package"

type = "boolean"

option = ["--no-root"]

sources = ["fig"]

[[commands.subcommand.field]]

id = "sync"

label = "Sync environment with lock"

type = "boolean"

option = ["--sync"]

sources = ["fig"]

[[commands.subcommand.field]]

id = "dry_run"

label = "Dry run"

type = "boolean"

option = ["--dry-run"]

sources = ["fig"]

[[commands.subcommand.field]]

id = "all_extras"

label = "All extras"

type = "boolean"

option = ["--all-extras"]

sources = ["fig"]

[[commands.subcommand.field]]

id = "no_directory"

label = "Skip directory dependencies"

type = "boolean"

option = ["--no-directory"]

sources = ["fig"]

[[commands.subcommand.field]]

id = "only_root"

label = "Root package only"

type = "boolean"

option = ["--only-root"]

sources = ["fig"]

[[commands.subcommand.field]]

id = "compile"

label = "Compile bytecode"

type = "boolean"

option = ["--compile"]

sources = ["fig"]

[[commands.subcommand.task]]

id = "install"

label = "Install"

fields = ["no_root", "sync", "dry_run", "all_extras", "no_directory", "only_root", "compile"]

required = []

[[commands.subcommand.task]]

id = "ci"

label = "Exact sync, no root"

set = { sync = [true], no_root = [true] }

fields = ["sync", "no_root"]

required = []

[[commands.subcommand.group]]

id = "basic"

label = "Basic"

fields = ["no_root", "sync", "dry_run", "all_extras", "no_directory"]

[[commands.subcommand.group]]

id = "advanced"

label = "Advanced"

fields = ["only_root", "compile"]

[[commands.subcommand]]

path = ["run"]

label = "Run a command"

[[commands.subcommand.source]]

id = "fig"

kind = "completion"

url = "https://github.com/withfig/autocomplete/blob/master/src/poetry.ts"

license = "MIT"

[[commands.subcommand.field]]

id = "args"

label = "Command and arguments"

type = "string"

position = 0

multiple = true

sources = ["fig"]

[[commands.subcommand.task]]

id = "run"

label = "Run"

fields = ["args"]

required = ["args"]

[[commands.subcommand.group]]

id = "basic"

label = "Basic"

fields = ["args"]

Use it with your dotfile manager

Same data, in the shape your tool already reads

Opens Otty and adds this tool to what it syncs

Opens otty://sync/add/poetry. Otty ships with this catalog, so the link only has to name the tool — nothing is downloaded.

Every one of these keeps the credential file out. None of them splits cache-dir and virtualenvs.path for you — that part is Otty’s own sync, or a template you write by hand.