| Name | keyrings.codeartifact JSON |
| Version |
1.3.3
JSON |
| download |
| home_page | None |
| Summary | Automatically retrieve credentials for AWS CodeArtifact. |
| upload_time | 2024-06-29 15:56:20 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8.0 |
| license | MIT License Copyright (c) 2022 Joshua M. Keyes <joshua.michael.keyes@gmail.com> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
aws
codeartifact
keyring
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
AWS CodeArtifact Keyring Backend
================================
The `keyrings.codeartifact` package provides authentication for publishing and consuming packages within a private
PyPi repository hosted on [AWS CodeArtifact](https://aws.amazon.com/codeartifact/); it contains an extension to the
[keyring](https://pypi.org/project/keyring/) library that will automatically inject a time-limited access token.
Installation
------------
To install this package, install the "keyrings.codeartifact" package using `pip`:
```
pip install keyrings.codeartifact
```
Usage
-----
The `keyring` library has been integrated with recent versions of pip and twine. Once installed, this library will
automatically supply credentials whenever pip/twine (or other keyring-enabled package) attempts to use a repository
hosted within CodeArtifact. It will use any appropriate AWS credentials provided in `~/.aws/credentials` by default.
```
--index-url https://${DOMAIN}-${ACCOUNT}.d.codeartifact.${REGION}.amazonaws.com/pypi/${REPOSITORY}/simple/
```
Config
------
This backend provides a number of configuration options to modify the behaviour of the AWS client.
The configuration options can be specified within `[codeartifact]` sections of the `keyringrc.cfg`.
Run `keyring diagnose` to find its as the location; it varies between different platforms.
Available options:
- `profile_name`: Use a specific AWS profile to authenticate with AWS.
- `token_duration`: Validity period (in seconds) for retieved authorization tokens.
- `aws_access_key_id`: Use a specific AWS access key to authenticate with AWS.
- `aws_secret_access_key`: Use a specific AWS secret access key to authenticate with AWS.
For more explanation of these options see the [AWS CLI documentation](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html).
### Single Section Configuration
A trivial example `keyringrc.cfg` section for a single account:
```ini
[codeartifact]
# Tokens should only be valid for 30 minutes.
token_duration=1800
# Use the 'default' profile name.
profile_name=default
# Use the following access keys.
aws_access_key_id=xxxxxxxxx
aws_secret_access_key=xxxxxxxxx
```
### Multiple Section Configuration (EXPERIMENTAL)
This backend can use multiple sections to select different configuration values.
Each section may also have any of the following "qualifiers" in any order:
- `domain`: Matches on the repository domain.
- `account`: Matches on the repository account.
- `region`: Matches on the repository region.
- `name`: Matches on the repository name.
When looking up a CodeArtifact URL, each matching qualifier ranks that section higher.
The section with highest score (ie: the most specific match) will be selected for that URL.
When configured in this manner, the `codeartifact` section will specify default values.
An example of a more advanced configuration for using multiple sections:
```ini
# These are the defaults for other sections.
[codeartifact]
token_duration=1800
# Use for any repositories in account 000000000000.
[codeartifact account="000000000000"]
profile_name=special_profile
# Use for account 999999999999 with a repository named "staging".
[codeartifact account="999999999999" name="staging"]
profile_name=staging_profile
```
Raw data
{
"_id": null,
"home_page": null,
"name": "keyrings.codeartifact",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8.0",
"maintainer_email": null,
"keywords": "aws, codeartifact, keyring",
"author": null,
"author_email": "\"Joshua M. Keyes\" <joshua.michael.keyes@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/a8/e9/3efb931ec0f4f73362a12d1c15cc1d808ad21e384ed636f4e3278cf721b7/keyrings_codeartifact-1.3.3.tar.gz",
"platform": null,
"description": "AWS CodeArtifact Keyring Backend\n================================\n\nThe `keyrings.codeartifact` package provides authentication for publishing and consuming packages within a private\nPyPi repository hosted on [AWS CodeArtifact](https://aws.amazon.com/codeartifact/); it contains an extension to the\n[keyring](https://pypi.org/project/keyring/) library that will automatically inject a time-limited access token.\n\nInstallation\n------------\nTo install this package, install the \"keyrings.codeartifact\" package using `pip`:\n\n```\npip install keyrings.codeartifact\n```\n\nUsage\n-----\nThe `keyring` library has been integrated with recent versions of pip and twine. Once installed, this library will\nautomatically supply credentials whenever pip/twine (or other keyring-enabled package) attempts to use a repository\nhosted within CodeArtifact. It will use any appropriate AWS credentials provided in `~/.aws/credentials` by default.\n\n```\n--index-url https://${DOMAIN}-${ACCOUNT}.d.codeartifact.${REGION}.amazonaws.com/pypi/${REPOSITORY}/simple/\n```\n\nConfig\n------\nThis backend provides a number of configuration options to modify the behaviour of the AWS client.\n\nThe configuration options can be specified within `[codeartifact]` sections of the `keyringrc.cfg`.\n\nRun `keyring diagnose` to find its as the location; it varies between different platforms.\n\nAvailable options:\n\n - `profile_name`: Use a specific AWS profile to authenticate with AWS.\n - `token_duration`: Validity period (in seconds) for retieved authorization tokens.\n - `aws_access_key_id`: Use a specific AWS access key to authenticate with AWS.\n - `aws_secret_access_key`: Use a specific AWS secret access key to authenticate with AWS.\n\nFor more explanation of these options see the [AWS CLI documentation](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html).\n\n### Single Section Configuration\n\nA trivial example `keyringrc.cfg` section for a single account:\n\n```ini\n[codeartifact]\n# Tokens should only be valid for 30 minutes.\ntoken_duration=1800\n\n# Use the 'default' profile name.\nprofile_name=default\n\n# Use the following access keys.\naws_access_key_id=xxxxxxxxx\naws_secret_access_key=xxxxxxxxx\n\n```\n\n### Multiple Section Configuration (EXPERIMENTAL)\n\nThis backend can use multiple sections to select different configuration values.\n\nEach section may also have any of the following \"qualifiers\" in any order:\n\n - `domain`: Matches on the repository domain.\n - `account`: Matches on the repository account.\n - `region`: Matches on the repository region.\n - `name`: Matches on the repository name.\n\nWhen looking up a CodeArtifact URL, each matching qualifier ranks that section higher.\n\nThe section with highest score (ie: the most specific match) will be selected for that URL.\n\nWhen configured in this manner, the `codeartifact` section will specify default values.\n\nAn example of a more advanced configuration for using multiple sections:\n\n```ini\n# These are the defaults for other sections.\n[codeartifact]\ntoken_duration=1800\n\n# Use for any repositories in account 000000000000.\n[codeartifact account=\"000000000000\"]\nprofile_name=special_profile\n\n# Use for account 999999999999 with a repository named \"staging\".\n[codeartifact account=\"999999999999\" name=\"staging\"]\nprofile_name=staging_profile\n```\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2022 Joshua M. Keyes <joshua.michael.keyes@gmail.com> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Automatically retrieve credentials for AWS CodeArtifact.",
"version": "1.3.3",
"project_urls": {
"Homepage": "https://github.com/jmkeyes/keyrings.codeartifact",
"Issues": "https://github.com/jmkeyes/keyrings.codeartifact/issues",
"Repository": "https://github.com/jmkeyes/keyrings.codeartifact.git"
},
"split_keywords": [
"aws",
" codeartifact",
" keyring"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "087a4c0ec41f92987ce3127aef93c0812cf9371b544568dbb4e0ff8ba490e995",
"md5": "a8daccafbdff8cda68f618f949156f0b",
"sha256": "91cf4db572d5e668198a63bed49ba163b0aadf9b0217f6ba112e0f3d1fd78a62"
},
"downloads": -1,
"filename": "keyrings.codeartifact-1.3.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a8daccafbdff8cda68f618f949156f0b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8.0",
"size": 7240,
"upload_time": "2024-06-29T15:56:19",
"upload_time_iso_8601": "2024-06-29T15:56:19.428736Z",
"url": "https://files.pythonhosted.org/packages/08/7a/4c0ec41f92987ce3127aef93c0812cf9371b544568dbb4e0ff8ba490e995/keyrings.codeartifact-1.3.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a8e93efb931ec0f4f73362a12d1c15cc1d808ad21e384ed636f4e3278cf721b7",
"md5": "656fcfd1dea053ac85b5d7069e99cb11",
"sha256": "9ab26cec8d95feebba1c0086c5bba116f00bdeb5449d52ce31df2037aeb5e5a5"
},
"downloads": -1,
"filename": "keyrings_codeartifact-1.3.3.tar.gz",
"has_sig": false,
"md5_digest": "656fcfd1dea053ac85b5d7069e99cb11",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8.0",
"size": 9306,
"upload_time": "2024-06-29T15:56:20",
"upload_time_iso_8601": "2024-06-29T15:56:20.909763Z",
"url": "https://files.pythonhosted.org/packages/a8/e9/3efb931ec0f4f73362a12d1c15cc1d808ad21e384ed636f4e3278cf721b7/keyrings_codeartifact-1.3.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-29 15:56:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jmkeyes",
"github_project": "keyrings.codeartifact",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "keyrings.codeartifact"
}
