## keyring provider for octoDNS
An [octoDNS](https://github.com/octodns/octodns/) secrets handler that targets [keyring](https://pypi.org/project/keyring/).
### Installation
#### Command line
```
pip install octodns-keyring
```
#### requirements.txt/setup.py
Pinning specific versions or SHAs is recommended to avoid unplanned upgrades.
##### Versions
```
# Start with the latest versions and don't just copy what's here
octodns==0.9.14
octodns-keyring==0.0.1
```
##### SHAs
```
# Start with the latest/specific versions and don't just copy what's here
-e git+https://git@github.com/octodns/octodns.git@9da19749e28f68407a1c246dfdf65663cdc1c422#egg=octodns
-e git+https://git@github.com/octodns/octodns-keyring.git@ec9661f8b335241ae4746eea467a8509205e6a30#egg=octodns_keyring
```
### Configuration
```yaml
secret_handlers:
keyring:
class: octodns_keyring.KeyringSecrets
# The keyring backend to use (optional.) If omitted keyrings built-in
# process will apply
backend: keyring.backends.null.Keyring
providers:
route53:
class: octodns_route53.Ec2Source
access_key_id: keyring/octodns/AWS_ACCESS_KEY_ID
secret_access_key: keyring/octodns/AWS_SECRET_ACCESS_KEY
region: us-east-1
```
### Development
See the [/script/](/script/) directory for some tools to help with the development process. They generally follow the [Script to rule them all](https://github.com/github/scripts-to-rule-them-all) pattern. Most useful is `./script/bootstrap` which will create a venv and install both the runtime and development related requirements. It will also hook up a pre-commit hook that covers most of what's run by CI.
Raw data
{
"_id": null,
"home_page": "https://github.com/octodns/octodns-keyring",
"name": "octodns-keyring",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "Ross McFarland",
"author_email": "rwmcfa1@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/44/2f/eda8d54990e45c62a3740f1a8e9726e0ab5c74b4ea91cd2f16c00eeb861c/octodns-keyring-0.0.1.tar.gz",
"platform": null,
"description": "## keyring provider for octoDNS\n\nAn [octoDNS](https://github.com/octodns/octodns/) secrets handler that targets [keyring](https://pypi.org/project/keyring/).\n\n### Installation\n\n#### Command line\n\n```\npip install octodns-keyring\n```\n\n#### requirements.txt/setup.py\n\nPinning specific versions or SHAs is recommended to avoid unplanned upgrades.\n\n##### Versions\n\n```\n# Start with the latest versions and don't just copy what's here\noctodns==0.9.14\noctodns-keyring==0.0.1\n```\n\n##### SHAs\n\n```\n# Start with the latest/specific versions and don't just copy what's here\n-e git+https://git@github.com/octodns/octodns.git@9da19749e28f68407a1c246dfdf65663cdc1c422#egg=octodns\n-e git+https://git@github.com/octodns/octodns-keyring.git@ec9661f8b335241ae4746eea467a8509205e6a30#egg=octodns_keyring\n```\n\n### Configuration\n\n```yaml\nsecret_handlers:\n keyring:\n class: octodns_keyring.KeyringSecrets\n # The keyring backend to use (optional.) If omitted keyrings built-in\n # process will apply\n backend: keyring.backends.null.Keyring\n\nproviders:\n route53:\n class: octodns_route53.Ec2Source\n access_key_id: keyring/octodns/AWS_ACCESS_KEY_ID\n secret_access_key: keyring/octodns/AWS_SECRET_ACCESS_KEY\n region: us-east-1\n```\n\n### Development\n\nSee the [/script/](/script/) directory for some tools to help with the development process. They generally follow the [Script to rule them all](https://github.com/github/scripts-to-rule-them-all) pattern. Most useful is `./script/bootstrap` which will create a venv and install both the runtime and development related requirements. It will also hook up a pre-commit hook that covers most of what's run by CI.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "keyring provider for octoDNS",
"version": "0.0.1",
"project_urls": {
"Homepage": "https://github.com/octodns/octodns-keyring"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "861cd2ef726745d9656804a1bcf9a2712005e00468556ac4c2c1233d3320f0fc",
"md5": "1a6a7f1c4adf66773ca7ec7f6e0a3c6e",
"sha256": "9a37a51e7cf8b4b0361154d6d3df438f1cc7bd35d0b09b63e5c9b3069d752c05"
},
"downloads": -1,
"filename": "octodns_keyring-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1a6a7f1c4adf66773ca7ec7f6e0a3c6e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 3708,
"upload_time": "2024-03-11T22:27:39",
"upload_time_iso_8601": "2024-03-11T22:27:39.754250Z",
"url": "https://files.pythonhosted.org/packages/86/1c/d2ef726745d9656804a1bcf9a2712005e00468556ac4c2c1233d3320f0fc/octodns_keyring-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "442feda8d54990e45c62a3740f1a8e9726e0ab5c74b4ea91cd2f16c00eeb861c",
"md5": "ad33ad08f942487b44ad6b39cc43156d",
"sha256": "1e294b8a58ec865e146b484c69c1a559c2d59089a9020deca595b8b9da4c173a"
},
"downloads": -1,
"filename": "octodns-keyring-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "ad33ad08f942487b44ad6b39cc43156d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 4727,
"upload_time": "2024-03-11T22:27:41",
"upload_time_iso_8601": "2024-03-11T22:27:41.364084Z",
"url": "https://files.pythonhosted.org/packages/44/2f/eda8d54990e45c62a3740f1a8e9726e0ab5c74b4ea91cd2f16c00eeb861c/octodns-keyring-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-11 22:27:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "octodns",
"github_project": "octodns-keyring",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "octodns-keyring"
}
JSON
