> For the complete CircleCI developer hub index, see [llms.txt](https://circleci.com/developer/llms.txt)

# talkiq/poetry

Tools for running poetry commands.

## Commands

### install

Install poetry. Requires a pre-existing Python 3.x installation. Currently supported package managers: apk, apt-get.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `allow_preview` | boolean | false | Allow prerelease versions of Poetry to be installed.
 |
| `version` | string | latest | Specify the version of poetry to install. Must be either an "x.y.z" version or "latest".
 |

## Jobs

### publish

Publishes your package to the specified repository.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `build` | boolean | true | If false, skip the 'poetry build' step. Useful for workflows with complicated build processes.
 |
| `build_timeout` | string | 10m | Sets the timeout value for 'poetry build' step. Useful for workflows with longer build times.
 |
| `cwd` | string | . | Working directory for your package. Should point to a folder containing your pyproject.toml file.
 |
| `executor` | executor | python-latest | Executor for the job. Must have a working Python version installed. To use your own custom executor, see `https://circleci.com/docs/2.0/reusing-config/#authoring-reusable-executors`. Defaults to a small python:latest docker image.
 |
| `password` | string |  | Password to be used for authenticating against the specified repository. Note that some indexes such as Gemfury use the username field for your personal access token; in that case, set this value to the same value as the username.
 |
| `repository` | string | pypi | Name of the repository you wish to upload to. If using a non-default repository, you'll need to define it in your pyproject.toml or provide a URL with the repository_url parameters.
 |
| `repository_url` | string |  | URL of repository not provided in pyproject.toml. Uses repository parameter as name of repository for configuration.
 |
| `username` | string |  | Username to be used for authenticating against the specified repository.
 |

### run

Run an arbitrary command within your poetry environment.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `commands` | steps |  | The step (or steps) you want to run. For example: ``` - run: poetry build - run: poetry run pytest ```
 |
| `configure_poetry` | steps |  | If there are any configurations that must occur prior to running poetry, use this parameter to specify them over pre-steps. This parameter runs immediately after poetry's installation, but before any business logic.
In other words, you may want to set this value to something like: ``` - run: poetry self add keyrings.google-artifactregistry-auth - run: poetry config http-basic.repo-name username password - run: poetry config repositories.backup-repo url ```
 |
| `cwd` | string | . | Working directory for your package. Should point to a folder containing your pyproject.toml file.
 |
| `executor` | executor | python-latest | Executor for the job. Must have a working Python version installed. To use your own custom executor, see `https://circleci.com/docs/2.0/reusing-config/#authoring-reusable-executors`. Defaults to a small python:latest docker image.
 |
| `install_flags` | string |  | Extra flags to add to `poetry install` command.
 |
| `version` | string | latest | Specify the version of poetry to use. Must be either an "x.y.z" version or "latest".
 |

## Executors

### python-latest