Skip to main content

"Automatically retrieve credentials for Azure Artifacts."

Project description

NOTE

'artifacts-keyring' is a relatively thin wrapper around artifacts-credprovider. Make sure to also look at that repository for more information about different scenarios. For example:

artifacts-keyring

The artifacts-keyring package provides authentication for publishing or consuming Python packages to or from Azure Artifacts feeds within Azure DevOps.

This package is an extension to keyring, which will automatically find and use it once installed.

Both pip and twine will use keyring to find credentials.

Installation

To install this package, run the following pip command:

pip install artifacts-keyring

Usage

Requirements

To use artifacts-keyring to set up authentication between pip/twine and Azure Artifacts, the following requirements must be met:

  • pip version 19.2 or higher
  • twine version 1.13.0 or higher
  • python version 3.0 or higher
  • .Net SDK is installed. Refer to here for installation guideline.

Publishing packages to an Azure Artifacts feed

Once artifacts-keyring is installed, to publish a package, use the following twine command, replacing <org_name> and <feed_name> with your own:

twine upload --repository-url https://pkgs.dev.azure.com/<org_name>/_packaging/<feed_name>/pypi/upload <package_wheel_or_other_dist_format>

Installing packages from an Azure Artifacts feed

Once artifacts-keyring is installed, to consume a package, use the following pip command, replacing <org_name> and <feed_name> with your own, and <package_name> with the package you want to install:

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

Advanced configuration

The artifacts-keyring package is layered on top of our Azure Artifacts Credential Provider. Check out that link to the GitHub repo for more information on configuration options.

Environment variables

  • ARTIFACTS_KEYRING_NONINTERACTIVE_MODE: Controls whether the underlying credential provider can issue interactive prompts.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

artifacts-keyring-0.0.1rc3.tar.gz (12.1 MB view details)

Uploaded Source

Built Distribution

artifacts_keyring-0.0.1rc3-py2.py3-none-any.whl (12.9 MB view details)

Uploaded Python 2 Python 3

File details

Details for the file artifacts-keyring-0.0.1rc3.tar.gz.

File metadata

  • Download URL: artifacts-keyring-0.0.1rc3.tar.gz
  • Upload date:
  • Size: 12.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.13

File hashes

Hashes for artifacts-keyring-0.0.1rc3.tar.gz
Algorithm Hash digest
SHA256 04da28d25025e0bf4770bdb86ef99fc5d278895cb52c109328e61ef82887b86f
MD5 29ad14b4df548335756a569bc7ea03ad
BLAKE2b-256 2a498c8edfad863e75ed25b7af81cb1bc751d96f7e99fa4f83b8578e9d040263

See more details on using hashes here.

File details

Details for the file artifacts_keyring-0.0.1rc3-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for artifacts_keyring-0.0.1rc3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f6ea950fedcf6d144412d197f6de7b8fb2370b25fc1200bd3275219bf01740ba
MD5 c5e2613506baebb0c66fed7084605425
BLAKE2b-256 d40e4856a748d5e46c18207c673ad8f38d798a5831cd44b0ce05cdb6f2de1514

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page