# Secrets backend for Pants
[](https://pypi.org/project/pants-backend-secrets)
> **Warning**
> This plugin is in development. No stability is guaranteed! Contributions welcome.
This backends implements utilities for handling secrets.
## Planned and missing features
* Setting and creating secrets via Pants
## Targets
### `env_secret`
A secret to be read from the environment.
``` python
env_secret(
name="bw_session_key",
key="BW_SESSION",
)
```
| Argument | Meaning | Default value |
|---------------|-----------------------------------|-------------------------------------------------------|
| `name` | The target name | Same as any other target, which is the directory name |
| `key` | The environment variable to read. | **Required** |
| `decsription` | A description of the target | ` ` |
| `tags` | List of tags | `[]` |
## Goals
### `decrypt`
Decrypts and prints a secret.
```console
BW_SESSION="..." pants decrypt //examples/bitwarden:pypi_token
22:29:42.17 [INFO] Completed: Decrypting examples/bitwarden:pypi_token
Secret examples/bitwarden:pypi_token from BitWarden: pypi-...
```
Raw data
{
"_id": null,
"home_page": null,
"name": "pants-backend-secrets",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "pantsbuild, pants, backend, secrets",
"author": null,
"author_email": "Tom Solberg <me@sbg.dev>",
"download_url": "https://files.pythonhosted.org/packages/ff/91/dee5a0a23e5e9a869b8756f14849539f01037809fda66fb901389d3b32e2/pants-backend-secrets-0.4.0.tar.gz",
"platform": null,
"description": "# Secrets backend for Pants\n\n[](https://pypi.org/project/pants-backend-secrets)\n\n> **Warning**\n> This plugin is in development. No stability is guaranteed! Contributions welcome.\n\nThis backends implements utilities for handling secrets.\n\n## Planned and missing features\n\n* Setting and creating secrets via Pants\n\n## Targets\n\n### `env_secret`\n\nA secret to be read from the environment.\n\n``` python\nenv_secret(\n name=\"bw_session_key\",\n key=\"BW_SESSION\",\n)\n```\n\n| Argument | Meaning | Default value |\n|---------------|-----------------------------------|-------------------------------------------------------|\n| `name` | The target name | Same as any other target, which is the directory name |\n| `key` | The environment variable to read. | **Required** |\n| `decsription` | A description of the target | ` ` |\n| `tags` | List of tags | `[]` |\n\n\n## Goals\n\n### `decrypt`\n\nDecrypts and prints a secret.\n\n```console\nBW_SESSION=\"...\" pants decrypt //examples/bitwarden:pypi_token\n22:29:42.17 [INFO] Completed: Decrypting examples/bitwarden:pypi_token\nSecret examples/bitwarden:pypi_token from BitWarden: pypi-...\n```\n\n",
"bugtrack_url": null,
"license": null,
"summary": "A secrets plumbing plugin for the Pants build system",
"version": "0.4.0",
"project_urls": {
"Changelog": "https://github.com/tgolsson/pants-backends/tree/main/pants-plugins/secrets/CHANGELOG.md",
"Code": "https://github.com/tgolsson/pants-backends/tree/main/pants-plugins/secrets",
"Repository": "https://github.com/tgolsson/pants-backends"
},
"split_keywords": [
"pantsbuild",
" pants",
" backend",
" secrets"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "33289237cedafcdbb2768f6c8cc60b534338279d1929b383490e80c41890cb7d",
"md5": "afa3d2ac138192c20053b0315c4ce1b5",
"sha256": "261ef8b601f1d57e44d229cdbcd8550e2217be4cbc967f776843c177b1bf7dab"
},
"downloads": -1,
"filename": "pants_backend_secrets-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "afa3d2ac138192c20053b0315c4ce1b5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 10482,
"upload_time": "2024-09-19T12:07:31",
"upload_time_iso_8601": "2024-09-19T12:07:31.488747Z",
"url": "https://files.pythonhosted.org/packages/33/28/9237cedafcdbb2768f6c8cc60b534338279d1929b383490e80c41890cb7d/pants_backend_secrets-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ff91dee5a0a23e5e9a869b8756f14849539f01037809fda66fb901389d3b32e2",
"md5": "3a5b4fb7d423afa88f9503af0ae54611",
"sha256": "6d98e8eecfa6bdb82d49c66366ed5b6d73288afd68910823d52fb8e7fa5220a6"
},
"downloads": -1,
"filename": "pants-backend-secrets-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "3a5b4fb7d423afa88f9503af0ae54611",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7973,
"upload_time": "2024-09-19T12:07:32",
"upload_time_iso_8601": "2024-09-19T12:07:32.525783Z",
"url": "https://files.pythonhosted.org/packages/ff/91/dee5a0a23e5e9a869b8756f14849539f01037809fda66fb901389d3b32e2/pants-backend-secrets-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-19 12:07:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tgolsson",
"github_project": "pants-backends",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pants-backend-secrets"
}
JSON
