poetry-source-env 1.1.0

Load Poetry package sources from environment variables

poetry-source-env

poetry-source-env is a Poetry plugin that lets you define private package sources for your project without exposing their URLs in pyproject.toml. It can load package source definitions from environment variables and expand environment variables in the tool.poetry.source section of pyproject.toml.

This plugin is intended as a workaround for python-poetry/poetry#5958 and will be deprecated if comparable functionality is ever implemented in Poetry itself.

Installation

poetry self add poetry-source-env

Usage

Normally, you would define a package source in pyproject.toml like this:

[[tool.poetry.source]]
name = "my-epic-source"
url = "https://pkg.celsiusnarhwal.dev"
default = false
secondary = false

With poetry-source-env, you can define this source via environment variables, similar to how you can already configure publishable repositories:

export POETRY_REPOSITORIES_MY_EPIC_SOURCE_URL=https://pkg.celsiusnarhwal.dev
export POETRY_REPOSITORIES_MY_EPIC_SOURCE_DEFAULT=false
export POETRY_REPOSITORIES_MY_EPIC_SOURCE_SECONDARY=false

If you prefer to keep the source defined in pyproject.toml, you can opt to conceal parts of its definition behind environment variables:

export INDEX_URL="https://pkg.celsiusnarhwal.dev"

[[tool.poetry.source]]
name = "my-epic-source"
url = "${INDEX_URL}"
default = false
secondary = false

If your source requires authentication, Poetry already supports defining its credentials via environment variables:

export POETRY_HTTP_BASIC_MY_EPIC_SOURCE_USERNAME=celsiusnarhwal
export POETRY_HTTP_BASIC_MY_EPIC_SOURCE_PASSWORD=superdupersecret

Configuration

poetry-source-env's behavior can be configured via the tool.poetry-source-env section of pyproject.toml.

Supported configuration options include:

Name	Type	Description	Required?	Default
prefix	string	The prefix which poetry-source-env should expect source-defining environment variables to use. Has no effect if env is false.	No	POETRY_REPOSITORIES_
env	boolean	Whether to read package source definitions from environment variables.	No	true
toml	boolean	Whether to expand environment variables in the tool.poetry.source section of pyproject.toml.	No	true

License

poetry-source-env is licensed under the MIT License.