fuzzy-secret-stdout


Namefuzzy-secret-stdout JSON
Version 0.3.0 PyPI version JSON
download
home_pagehttps://pypi.org/project/fuzzy-secret-stdout/
SummarySmall utility to fuzzy search from a secret store and print the value to stdout
upload_time2024-01-20 09:15:08
maintainer
docs_urlNone
authorkiran94
requires_python>=3.9,<4.0
licenseMIT
keywords aws secrets ssm parameter-store
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # `fuzzy-secret-stdout`

> Small utility to fuzzy search from a secret store and print the value to stdout

[![main](https://github.com/kiran94/fuzzy-secret-stdout/actions/workflows/main.yml/badge.svg)](https://github.com/kiran94/fuzzy-secret-stdout/actions/workflows/main.yml)
![GitHub License](https://img.shields.io/github/license/kiran94/fuzzy-secret-stdout)
![PyPI - Version](https://img.shields.io/pypi/v/fuzzy-secret-stdout)

## Install

```bash
python -m pip install fuzzy-secret-stdout
```

Dependencies:

* Python 3.9+
* [`fzf`](https://github.com/junegunn/fzf?tab=readme-ov-file#installation)
* Valid [AWS Credentials](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html) available your terminal context

## Usage

```bash
# fuzzy search from secrets from aws parameter store
fuzzy-secret-stdout

# alias for the above
fss

# fuzzy search and explicitly specify the secret store to search
fss -i AWS_SECRET_MAN

# fuzzy search aws secret manager and pipe into jq
fss -i AWS_SECRET_MAN | jq .
```

## Integrations

`fuzzy-secret-stdout` supports the following secret stores:

| Secret Store                                                                                                                             | Command Line Argument  |
| -------------                                                                                                                            | ---------------------- |
| [AWS Systems Manager Parameter Store](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-parameter-store.html) | `AWS_SSM`              |
| [AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html)                                            | `AWS_SECRET_MAN`       |

The *Command Line Argument* above is passed as the `-i` flag. `AWS_SSM` is the default.

## Environment Variables

| Environment Variables   | Description                                                                                                                                                                                                                       | Default  |
| ---------------------   | ----------                                                                                                                                                                                                                       | -------- |
| `FSS_MAX_BATCH_RESULTS` | The maximum number of results to request from the underlying secret service per batch. Note that this value might be rejected by the underlying secret service. For example `boto3` validates this value to be <= 50 for AWS SSM | `50`     |

            

Raw data

            {
    "_id": null,
    "home_page": "https://pypi.org/project/fuzzy-secret-stdout/",
    "name": "fuzzy-secret-stdout",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9,<4.0",
    "maintainer_email": "",
    "keywords": "aws,secrets,ssm,parameter-store",
    "author": "kiran94",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/02/b7/51d1df6d31f05db3849dbcaaab4cc4b95ef2a8d2a09c934b55a29c581fa9/fuzzy_secret_stdout-0.3.0.tar.gz",
    "platform": null,
    "description": "# `fuzzy-secret-stdout`\n\n> Small utility to fuzzy search from a secret store and print the value to stdout\n\n[![main](https://github.com/kiran94/fuzzy-secret-stdout/actions/workflows/main.yml/badge.svg)](https://github.com/kiran94/fuzzy-secret-stdout/actions/workflows/main.yml)\n![GitHub License](https://img.shields.io/github/license/kiran94/fuzzy-secret-stdout)\n![PyPI - Version](https://img.shields.io/pypi/v/fuzzy-secret-stdout)\n\n## Install\n\n```bash\npython -m pip install fuzzy-secret-stdout\n```\n\nDependencies:\n\n* Python 3.9+\n* [`fzf`](https://github.com/junegunn/fzf?tab=readme-ov-file#installation)\n* Valid [AWS Credentials](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html) available your terminal context\n\n## Usage\n\n```bash\n# fuzzy search from secrets from aws parameter store\nfuzzy-secret-stdout\n\n# alias for the above\nfss\n\n# fuzzy search and explicitly specify the secret store to search\nfss -i AWS_SECRET_MAN\n\n# fuzzy search aws secret manager and pipe into jq\nfss -i AWS_SECRET_MAN | jq .\n```\n\n## Integrations\n\n`fuzzy-secret-stdout` supports the following secret stores:\n\n| Secret Store                                                                                                                             | Command Line Argument  |\n| -------------                                                                                                                            | ---------------------- |\n| [AWS Systems Manager Parameter Store](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-parameter-store.html) | `AWS_SSM`              |\n| [AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html)                                            | `AWS_SECRET_MAN`       |\n\nThe *Command Line Argument* above is passed as the `-i` flag. `AWS_SSM` is the default.\n\n## Environment Variables\n\n| Environment Variables   | Description                                                                                                                                                                                                                       | Default  |\n| ---------------------   | ----------                                                                                                                                                                                                                       | -------- |\n| `FSS_MAX_BATCH_RESULTS` | The maximum number of results to request from the underlying secret service per batch. Note that this value might be rejected by the underlying secret service. For example `boto3` validates this value to be <= 50 for AWS SSM | `50`     |\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Small utility to fuzzy search from a secret store and print the value to stdout",
    "version": "0.3.0",
    "project_urls": {
        "Documentation": "https://github.com/kiran94/fuzzy-secret-stdout/blob/main/README.md",
        "Homepage": "https://pypi.org/project/fuzzy-secret-stdout/",
        "Repository": "https://github.com/kiran94/fuzzy-secret-stdout"
    },
    "split_keywords": [
        "aws",
        "secrets",
        "ssm",
        "parameter-store"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c143c5420041169dfc79457a3d91aca4379c0d6b264adbbdc01ec1687a065014",
                "md5": "5b8866b86d63a43eec8639a276cd1359",
                "sha256": "5545d1c3e6e4cf3ddb157da5a7f30e2a0c22f7f1220523a0e54601835ec82a28"
            },
            "downloads": -1,
            "filename": "fuzzy_secret_stdout-0.3.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "5b8866b86d63a43eec8639a276cd1359",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9,<4.0",
            "size": 7332,
            "upload_time": "2024-01-20T09:15:07",
            "upload_time_iso_8601": "2024-01-20T09:15:07.694726Z",
            "url": "https://files.pythonhosted.org/packages/c1/43/c5420041169dfc79457a3d91aca4379c0d6b264adbbdc01ec1687a065014/fuzzy_secret_stdout-0.3.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "02b751d1df6d31f05db3849dbcaaab4cc4b95ef2a8d2a09c934b55a29c581fa9",
                "md5": "e3e11e6976355f05cc073e7efdbe11a7",
                "sha256": "1abc4e9e5eedb4c010ad071047c521e4218446402400c21a253a21ac687bd0e3"
            },
            "downloads": -1,
            "filename": "fuzzy_secret_stdout-0.3.0.tar.gz",
            "has_sig": false,
            "md5_digest": "e3e11e6976355f05cc073e7efdbe11a7",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9,<4.0",
            "size": 4756,
            "upload_time": "2024-01-20T09:15:08",
            "upload_time_iso_8601": "2024-01-20T09:15:08.871467Z",
            "url": "https://files.pythonhosted.org/packages/02/b7/51d1df6d31f05db3849dbcaaab4cc4b95ef2a8d2a09c934b55a29c581fa9/fuzzy_secret_stdout-0.3.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-01-20 09:15:08",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "kiran94",
    "github_project": "fuzzy-secret-stdout",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "fuzzy-secret-stdout"
}
        
Elapsed time: 0.17455s