poetry-aws-plugin 0.1.12

A poetry plugin to help with AWS CodeArtifact authorization automatically

Poetry AWS Plugin

This is a poetry plugin to help with AWS CodeArtifact authorization by automatically getting the authorization token.

When installing or publishing packages through poetry, the plugin will check whether the command requires CodeArtifact authorization, and if so, adds it automatically.

The plugin will try two methods of authorization, in this order:

1. Use AWS credentials to run sts.AssumeRole, then use that role to run codeartifact.GetAuthorizationToken.
2. Use AWS credentials to run codeartifact.GetAuthorizationToken.

Installation

To install the plugin

poetry self add poetry-aws-plugin

To uninstall the plugin

poetry self remove poetry-aws-plugin

Usage

You must ensure that your AWS credentials are configured and discoverable by boto3. The boto3 documentation has details on how to configure your credentials and the order in which they searched.

When poetry runs a command that uses CodeArtifact, the plugin will automatically check whether the command needs authorization, and if so, requests a CodeArtifact authorization token and adds it to the command.

Your AWS credentials must be authorized to do atleast one of the following:

1. Run codeartifact.GetAuthorizationToken.
2. Run sts.AssumeRole to assume a role with authorization to run codeartifact.GetAuthorizationToken.

To use IAM roles to authorize, set the environment variable POETRY_AWS_PLUGIN_ROLE_ARN to the role's ARN before running any poetry commands.

For example:

POETRY_AWS_PLUGIN_ROLE_ARN='arn:aws:codeartifact:<region>:<account-id>:repository/<domain>/<domain-owner>/<repository>' poetry install

or

echo "export POETRY_AWS_PLUGIN_ROLE_ARN='arn:aws:codeartifact:<region>:<account-id>:repository/<domain>/<domain-owner>/<repository>'" >> ~/.bashrc
source ~/.bashrc
poetry install

You can find more details in AWS's CodeArtifact authentication and tokens documentation and CodeArtifact IAM documentation.

Misc

You can also authorize by setting the environment variable POETRY_AWS_PLUGIN_AUTH_TOKEN to the CodeArtifact authorization token. This may be useful in CI/CD pipelines and reducing poetry configuration.

For example:

POETRY_AWS_PLUGIN_AUTH_TOKEN='<codeartifact-authorization-token>' poetry install