Skip to main content

Python CLI: Ansible Keyring - A System Keyring Integration CLI

A Python CLI created by Megabyte Labs



subheader_description


Table of Contents

Overview

This repository is home to ansible-keyring a CLI that extends the ansible, ansible-playbook, and ansible-vault command to retrieve vault passwords from the system keyring. It is based on the work of ansible-tools with a couple usability improvements. The features it adds are:

  • Does not have to be run only in directories where ansible.cfg is present
  • New, shorter, more intuitive command aliases

{{ load:docs/partials/guide.md }}

Installation

To accomodate everyone, this CLI can be installed using a variety of methods.

PyPi

If you already have Python 3 and pip3 installed, you can install the CLI by running:

pip3 install {{(if customPyPiPackageName customPyPiPackageName (append repository.prefix.github slug))}}

Install Doctor

On macOS or Linux, you can run:

bash -sS https://install.doctor/py/{{(if customPyPiPackageName customPyPiPackageName (append repository.prefix.github slug))}}

And on Windows, you can run:

Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://install.doctor/py/{{(if customPyPiPackageName customPyPiPackageName (append repository.prefix.github slug))}}?os=win'))

Homebrew

If you have Homebrew installed, you can install the package by running:

brew install installdoc/py/{{(if customPyPiPackageName customPyPiPackageName (append repository.prefix.github slug))}}

Or if you prefer to keep Python off your system, and install a binary, you can run:

brew install installdoc/py/{{(if customPyPiPackageName customPyPiPackageName (append repository.prefix.github slug))}}-binary

Chocolatey

If you are on Windows, you can install a binary version (without the Python dependency), using Chocolatey:

choco install {{(if customPyPiPackageName customPyPiPackageName (append repository.prefix.github slug))}}

Binary Releases

There are also binaries (in various formats) available for download on both GitHub and GitLab.

Requirements

To run this project, all you need is Python 3 and pip3. See the Installation section for instructions that include alternate installation methods that do not require Python to be installed.

If you are interested in contributing or would like to make some modifications, please see the CONTRIBUTING guide. There are a handful of build tools we incorporate into the development process. All of them are installed automatically via our Taskfile system. You can get started customizing this project by running:

bash .config/scripts/start.sh
task start
task --list

Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page. If you would like to contribute, please take a look at the contributing guide.

Sponsorship

Dear Awesome Person,

I create open source projects out of love. Although I have a job, shelter, and as much fast food as I can handle, it would still be pretty cool to be appreciated by the community for something I have spent a lot of time and money on. Please consider sponsoring me! Who knows? Maybe I will be able to quit my job and publish open source full time.

Sincerely,

Brian Zalewski

Open Collective sponsors GitHub sponsors Patreon

License

Copyright © 2020-2021 Megabyte LLC. This project is MIT licensed.

Release files for ansible-keyring 1.2.7

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ansible-keyring 1.2.7
File Size Uploaded
ansible-keyring-1.2.7.tar.gz 13.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for ansible-keyring 1.2.7
File Interpreter ABI Platform
ansible_keyring-1.2.7-py3-none-any.whl Python 3 none any Details

Total release size: 28.6 kB

Release files / ansible-keyring-1.2.7.tar.gz

Download URL ansible-keyring-1.2.7.tar.gz
Size 13.8 kB
Tags Source
SHA-256 checksum
How to use checksums
beb1f1b48e24c1ab3d0431f86df0ebc44a7c00a440f34e8c75c209d2b5d9d771
BLAKE2b-256 checksum
How to use checksums
43e586ee516ba107624c3850f74b90f709cfb3a4a679d27a3dd6bc4c164910cd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.1.12 CPython/3.9.10 Linux/5.15.11-200.fc35.x86_64

Release files / ansible_keyring-1.2.7-py3-none-any.whl

Download URL ansible_keyring-1.2.7-py3-none-any.whl
Size 14.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3f251330f76f9575e314bebbae340f82e2b93c87a771ba88f091b2651ed9564c
BLAKE2b-256 checksum
How to use checksums
dab82f16b554612b41365d3d409b0ed46e1dd4226d6c633107c079bfd67f1f97
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.1.12 CPython/3.9.10 Linux/5.15.11-200.fc35.x86_64

Release history Release notifications | RSS feed

This release

1.2.7 This release

2 release files

1.2.6

2 release files

1.2.5

2 release files

1.2.4

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page