# BitWarden backend for Pants
[](https://pypi.org/project/pants-backend-bitwarden)
> **Warning**
> This plugin is in development. No stability is guaranteed! Contributions welcome.
This backends implements targets for reading BitWarden secrets.
* [bw](https://bitwarden.com/help/cli/) - the BitWarden CLI client
## Planned and missing features
* Setting and creating secrets via Pants
## Targets
### `bw_item`
Matches one entry in your vault.
``` python
bw_item(
name="pypi",
id="386c6037-cbdd-4aa3-ba80-9ed6661f751b",
session_secret=":bw_session_key",
)
```
| Argument | Meaning | Default value |
|------------------|-----------------------------------------------------------------|-------------------------------------------------------|
| `name` | The target name | Same as any other target, which is the directory name |
| `id` | Item id used by this target as seen in the address bar | **Required** |
| `item_name` | The name in the vault. If ambiguous this will fail. Prefer IDs. | ` ` |
| `session_secret` | The secret to use for the BW_SESSION variable. | `env["BW_SESSION"]` |
| `decsription` | A description of the target | ` ` |
| `tags` | List of tags | `[]` |
### `bw_password`
The password of an item in your vault.
``` python
bw_password(
name="pypi_password",
item=[":pypi"],
)
```
| Argument | Meaning | Default value |
|---------------|-----------------------------------|-------------------------------------------------------|
| `name` | The target name | Same as any other target, which is the directory name |
| `item` | The item containing the password. | **Required** |
| `decsription` | A description of the target | ` ` |
| `tags` | List of tags | `[]` |
### `bw_field`
A field from an item in your vault. These are the "Custom Fields" at the bottom of an item, not to be confused with attachments.
``` python
bw_field(
name="pypi_token",
field_name="api_token"
item=[":pypi"],
)
```
| Argument | Meaning | Default value |
|---------------|-----------------------------------|-------------------------------------------------------|
| `name` | The target name | Same as any other target, which is the directory name |
| `item` | The item containing the password. | **Required** |
| `field_name` | The item containing the password. | **Required** |
| `decsription` | A description of the target | ` ` |
| `tags` | List of tags | `[]` |
Raw data
{
"_id": null,
"home_page": "",
"name": "pants-backend-bitwarden",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "pantsbuild,pants,backend,bitwarden",
"author": "",
"author_email": "Tom Solberg <me@sbg.dev>",
"download_url": "https://files.pythonhosted.org/packages/30/a5/47e55fc39e117cea160c2d5d08962de46a1df723fe86b66bee872f871dee/pants-backend-bitwarden-0.3.0.tar.gz",
"platform": null,
"description": "# BitWarden backend for Pants\n\n[](https://pypi.org/project/pants-backend-bitwarden)\n\n> **Warning**\n> This plugin is in development. No stability is guaranteed! Contributions welcome.\n\nThis backends implements targets for reading BitWarden secrets.\n\n* [bw](https://bitwarden.com/help/cli/) - the BitWarden CLI client\n\n## Planned and missing features\n\n* Setting and creating secrets via Pants\n\n## Targets\n\n### `bw_item`\n\nMatches one entry in your vault.\n\n``` python\nbw_item(\n name=\"pypi\",\n id=\"386c6037-cbdd-4aa3-ba80-9ed6661f751b\",\n session_secret=\":bw_session_key\",\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| `id` | Item id used by this target as seen in the address bar | **Required** |\n| `item_name` | The name in the vault. If ambiguous this will fail. Prefer IDs. | ` ` |\n| `session_secret` | The secret to use for the BW_SESSION variable. | `env[\"BW_SESSION\"]` |\n| `decsription` | A description of the target | ` ` |\n| `tags` | List of tags | `[]` |\n\n\n### `bw_password`\n\nThe password of an item in your vault.\n\n``` python\nbw_password(\n name=\"pypi_password\",\n item=[\":pypi\"],\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| `item` | The item containing the password. | **Required** |\n| `decsription` | A description of the target | ` ` |\n| `tags` | List of tags | `[]` |\n\n### `bw_field`\n\nA field from an item in your vault. These are the \"Custom Fields\" at the bottom of an item, not to be confused with attachments.\n\n``` python\nbw_field(\n name=\"pypi_token\",\n\tfield_name=\"api_token\"\n item=[\":pypi\"],\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| `item` | The item containing the password. | **Required** |\n| `field_name` | The item containing the password. | **Required** |\n| `decsription` | A description of the target | ` ` |\n| `tags` | List of tags | `[]` |\n\n",
"bugtrack_url": null,
"license": "",
"summary": "A Bitwarden plugin for the Pants build system",
"version": "0.3.0",
"project_urls": {
"Changelog": "https://github.com/tgolsson/pants-backends/tree/main/pants-plugins/bitwarden/CHANGELOG.md",
"Code": "https://github.com/tgolsson/pants-backends/tree/main/pants-plugins/bitwarden",
"Repository": "https://github.com/tgolsson/pants-backends"
},
"split_keywords": [
"pantsbuild",
"pants",
"backend",
"bitwarden"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f1064c4451c7cb8191b20781d68e8c465a673441fff88c3fb8d3bf7aebb2edaa",
"md5": "18f1af92f58b767e68e9038e9cf29a37",
"sha256": "67780ad052c9fe493328ae74356e227bf60dcf0a8ad71888049aab5b4abffcbc"
},
"downloads": -1,
"filename": "pants_backend_bitwarden-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "18f1af92f58b767e68e9038e9cf29a37",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 7511,
"upload_time": "2023-11-21T18:46:41",
"upload_time_iso_8601": "2023-11-21T18:46:41.740562Z",
"url": "https://files.pythonhosted.org/packages/f1/06/4c4451c7cb8191b20781d68e8c465a673441fff88c3fb8d3bf7aebb2edaa/pants_backend_bitwarden-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "30a547e55fc39e117cea160c2d5d08962de46a1df723fe86b66bee872f871dee",
"md5": "e27ac0a8baff21382a4cb41d7707fefe",
"sha256": "a09d0a9339487830ae9cc0bebd5cfe41f2ebcab822b6c5f76a5b8a14952e78da"
},
"downloads": -1,
"filename": "pants-backend-bitwarden-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "e27ac0a8baff21382a4cb41d7707fefe",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5504,
"upload_time": "2023-11-21T18:46:42",
"upload_time_iso_8601": "2023-11-21T18:46:42.967867Z",
"url": "https://files.pythonhosted.org/packages/30/a5/47e55fc39e117cea160c2d5d08962de46a1df723fe86b66bee872f871dee/pants-backend-bitwarden-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-21 18:46:42",
"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-bitwarden"
}
JSON
