| Name | keybin JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | None |
| Summary | keybin is a command-line interface tool built with python for secure management of API and secret keys using the Panega Vault service. |
| upload_time | 2024-08-30 21:49:08 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# KeyBin
`keybin` is a command-line interface tool built with python for secure management of API and secret keys using the Panega Vault service.
## Initial Setup
Before using keybin, you need to perform the initial setup to configure your Panega Vault API token.
### Get Panega Vault API Token:
- Go to [Panega Vault](https://console.pangea.cloud/service/vault).
- Obtain your API token from the dashboard.
### MongoDb Token:
- Get you `MongoDb` URL
- Add it in the `.env` file with the name of `URL`
## Installation
Install my-project with npm
```bash
pip install keybin
```
## Features
- 🔐 Secure Secret Management: Store, retrieve, update, and delete secrets securely.
- 🛠️ Flexible Metadata: Add and update metadata in key-value pairs.
- 🏷️ Tag Management: Categorize secrets with tags for easy retrieval and management
## General Guide
### Initinializing your API key
Use `init` command to intialize your API key
### Guide to Update and Delete
- Get the id of your secret which you want to update or delete from 'getid' command
- Now use to id with `commands`
## Usage
### Getting Help
```bash
keybin --help [COMMAND]
```
Repale `[COMMAND]` with the command you need help with
### Adding a Secret
Add a secret to the vault
```bash
keybin store <SECRET_VALUE> [-n <SECRET_NAME>] [-k <KEY_TYPE>] [-f <FOLDER>] [-m <METADATA>] [-t <TAGS>]
```
* Arguments
- `value`: The secret value to store.
- -n, --name: A unique name to identify the secret.
- -k, --key_type: The type of the key (default is 'secret').
- -f, --folder: The folder where the secret will be stored.
- -m, --metadata: Additional metadata for the secret in the format key:value (e.g., [name:abc,product:xcompany]).
- -t, --tags: Tags to categorize the secret, separated by commas (e.g., [tags1,tags2]).
### Listing the Secrets
```bash
keybin list [-f <FOLDER>] [-t <TAGS>] [-n <NAME_CONTAINS>] [-c <CREATED_AT>] [-s <SIZE>] [-o <ORDER>] [-ob <ORDER_BY>] [-l <LAST>] [-i <INCLUDE_SECRETS>]
```
* Arguments
- -f, --folder: The folder containing the secrets.
- -t, --tags: Tags to filter the secrets by, separated by commas (e.g., [tags1,tags2]).
- -n, --name_contains: Filter by secrets whose names contain this value.
- -c, --created_at: Filter by secrets created after this date (ISO format).
- -s, --size: Maximum number of items to return (default is 50).
- -o, --order: Order of results (asc or desc).
- -ob, --order_by: Property to order the results by (e.g., created_at, name).
- -l, --last: ID of the last item from a previous query, for pagination.
- -i, --include_secrets: Whether to include the secret values in the results (true or false).
### Getting Id of a secret
```bash
keybin getid --name <SECRET_NAME>
```
* Arguments
- `--name`: The name of the secret you want to retrieve
### Updating Secret
```bash
keybin update <ID> [-n <NAME>] [-f <FOLDER>] [-m <METADATA>] [-t <TAGS>]
```
* Arguments
- `id`: The ID of the secret to update.
- -n, --name: New name for the secret.
- -f, --folder: New folder to move the secret to.
- -m, --metadata: New metadata for the secret in the format key:value (e.g., [name:abc,product:xcompany]).
- -t, --tags: New tags to assign to the secret, separated by commas (e.g., [tags1,tags2]).
### Deleting Secret
```bash
keybin delete <ID>
```
* Arguments
- `id`: The ID of the secret to delete.
Raw data
{
"_id": null,
"home_page": null,
"name": "keybin",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Yeshwant Kuriyavar <yeshwa916@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/77/77/c69db26cff2a4c29901f107aba01cdd2a94bf6ec8c14e8b5c7e4a15abf36/keybin-1.0.0.tar.gz",
"platform": null,
"description": "\n# KeyBin\n\n`keybin` is a command-line interface tool built with python for secure management of API and secret keys using the Panega Vault service.\n\n\n\n## Initial Setup\n\nBefore using keybin, you need to perform the initial setup to configure your Panega Vault API token.\n\n### Get Panega Vault API Token:\n\n- Go to [Panega Vault](https://console.pangea.cloud/service/vault).\n- Obtain your API token from the dashboard.\n\n### MongoDb Token:\n- Get you `MongoDb` URL \n- Add it in the `.env` file with the name of `URL`\n## Installation\n\nInstall my-project with npm\n\n```bash\npip install keybin\n```\n \n## Features\n\n- \ud83d\udd10 Secure Secret Management: Store, retrieve, update, and delete secrets securely.\n- \ud83d\udee0\ufe0f Flexible Metadata: Add and update metadata in key-value pairs.\n- \ud83c\udff7\ufe0f Tag Management: Categorize secrets with tags for easy retrieval and management\n\n\n## General Guide\n\n### Initinializing your API key\n\nUse `init` command to intialize your API key\n\n### Guide to Update and Delete\n- Get the id of your secret which you want to update or delete from 'getid' command\n- Now use to id with `commands`\n## Usage\n\n### Getting Help\n```bash\nkeybin --help [COMMAND]\n```\nRepale `[COMMAND]` with the command you need help with \n\n### Adding a Secret\n\nAdd a secret to the vault\n\n```bash\nkeybin store <SECRET_VALUE> [-n <SECRET_NAME>] [-k <KEY_TYPE>] [-f <FOLDER>] [-m <METADATA>] [-t <TAGS>]\n```\n* Arguments\n - `value`: The secret value to store.\n - -n, --name: A unique name to identify the secret.\n - -k, --key_type: The type of the key (default is 'secret').\n - -f, --folder: The folder where the secret will be stored.\n - -m, --metadata: Additional metadata for the secret in the format key:value (e.g., [name:abc,product:xcompany]).\n - -t, --tags: Tags to categorize the secret, separated by commas (e.g., [tags1,tags2]).\n\n ### Listing the Secrets\n ```bash\n keybin list [-f <FOLDER>] [-t <TAGS>] [-n <NAME_CONTAINS>] [-c <CREATED_AT>] [-s <SIZE>] [-o <ORDER>] [-ob <ORDER_BY>] [-l <LAST>] [-i <INCLUDE_SECRETS>]\n```\n* Arguments\n - -f, --folder: The folder containing the secrets.\n - -t, --tags: Tags to filter the secrets by, separated by commas (e.g., [tags1,tags2]).\n - -n, --name_contains: Filter by secrets whose names contain this value.\n - -c, --created_at: Filter by secrets created after this date (ISO format).\n - -s, --size: Maximum number of items to return (default is 50).\n - -o, --order: Order of results (asc or desc).\n - -ob, --order_by: Property to order the results by (e.g., created_at, name).\n - -l, --last: ID of the last item from a previous query, for pagination.\n - -i, --include_secrets: Whether to include the secret values in the results (true or false).\n\n### Getting Id of a secret\n```bash\nkeybin getid --name <SECRET_NAME>\n```\n\n* Arguments\n - `--name`: The name of the secret you want to retrieve\n### Updating Secret\n```bash\nkeybin update <ID> [-n <NAME>] [-f <FOLDER>] [-m <METADATA>] [-t <TAGS>]\n```\n* Arguments\n - `id`: The ID of the secret to update.\n - -n, --name: New name for the secret.\n - -f, --folder: New folder to move the secret to.\n - -m, --metadata: New metadata for the secret in the format key:value (e.g., [name:abc,product:xcompany]).\n - -t, --tags: New tags to assign to the secret, separated by commas (e.g., [tags1,tags2]).\n\n### Deleting Secret\n```bash\nkeybin delete <ID>\n```\n* Arguments\n - `id`: The ID of the secret to delete.\n",
"bugtrack_url": null,
"license": null,
"summary": "keybin is a command-line interface tool built with python for secure management of API and secret keys using the Panega Vault service.",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/Yeva916/keybin",
"Issues": "https://github.com/Yeva916/keybin/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0b9eb0b1468446775ee33c17e0145a7c8c889d6e8aa60bc152d28b6bdd488088",
"md5": "9a6693dbf9360579b326cb6cb7b155cd",
"sha256": "8759047dc9f0a437612c058497934ac4030dc7ed46c0695eb0967720890e9d3a"
},
"downloads": -1,
"filename": "keybin-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9a6693dbf9360579b326cb6cb7b155cd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 10430,
"upload_time": "2024-08-30T21:49:06",
"upload_time_iso_8601": "2024-08-30T21:49:06.025584Z",
"url": "https://files.pythonhosted.org/packages/0b/9e/b0b1468446775ee33c17e0145a7c8c889d6e8aa60bc152d28b6bdd488088/keybin-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7777c69db26cff2a4c29901f107aba01cdd2a94bf6ec8c14e8b5c7e4a15abf36",
"md5": "cfdcd48c1fb34a04bfbb1db043e599ca",
"sha256": "0258c82f37eb386361587dd22b8201175ff19d6c30a10984f409f94a07b8114e"
},
"downloads": -1,
"filename": "keybin-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "cfdcd48c1fb34a04bfbb1db043e599ca",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 9749,
"upload_time": "2024-08-30T21:49:08",
"upload_time_iso_8601": "2024-08-30T21:49:08.540206Z",
"url": "https://files.pythonhosted.org/packages/77/77/c69db26cff2a4c29901f107aba01cdd2a94bf6ec8c14e8b5c7e4a15abf36/keybin-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-30 21:49:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Yeva916",
"github_project": "keybin",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "keybin"
}
