Skip to content

Commit

Permalink
Automated documentation update [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed May 7, 2024
1 parent 5dabb88 commit f95b04a
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions src/artifacts-helper/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ Configures Codespace to authenticate with Azure Artifact feeds
| yarnAlias | Create alias for yarn | boolean | true |
| npxAlias | Create alias for npx | boolean | true |
| rushAlias | Create alias for rush | boolean | true |
| python | Install Python keyring helper for pip | boolean | false |

## Customizations

Expand Down Expand Up @@ -57,6 +58,19 @@ are put in place if they are not provided. An example of the `.npmrc` file creat
//pkgs.dev.azure.com/orgname/projectname/_packaging/feed1/npm/:[email protected]
```

## Python Keyring Helper

Add the optional `{ "python" : true }` to install a Python Keyring helper that will handle authentication
to Python feeds using the same mechanism as the other languages. To install a package just run something
like:

```
pip install <package_name> --index-url https://pkgs.dev.azure.com/<org_name>/_packaging/<feed_name>/pypi/simple
```

When the feed URL is an Azure Artifacts feed pip will use the keyring helper to provide the credentials needed
to download the package.

## OS Support

This feature is tested to work on Debian/Ubuntu and Mariner CBL 2.0
Expand Down

0 comments on commit f95b04a

Please sign in to comment.