| Name | plush-fabric JSON |
| Version |
1.0.9
JSON |
| download |
| home_page | None |
| Summary | Helper library for Fabric to simplify creating and managing GitHub deploy keys when deploying GitHub-hosted repositories |
| upload_time | 2025-01-02 02:41:47 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.12 |
| license | None |
| keywords |
fabric
github
deployment
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
Plush
==============
A helper library for [Fabric](https://www.fabfile.org) to simplify creating and managing GitHub deploy keys when deploying your GitHub-hosted
repository. Currently, Plush is only tested on Ubuntu 24.04 LTS.
Plush aims to make deployments easier by:
- Using OAuth flows to securely connect to the GitHub API on your behalf
(while supporting 2 factor auth and never handling your username/password)
- Generating SSH deploy keys on your target server/computer
- Registering these deploy keys with your GitHub repo programmatically
- Configuring your new clone to use the appropriate deploy key while not conflicting with other
SSH keys used elsewhere on your server
- ACL'ing these keys so they can be reused by people to fetch/deploy on your behalf
(and not readable by anyone else on the server)
- Example PowerShell scripts are provided that give tab completion around fab.exe
To see this project in action, follow the directions in Setup-Dev-Environment.md. You will need access to an Ubuntu 24.04 machine (ideally a VM).
## Usage
This project is intended to be used by projects that use or are considering [Fabric](https://www.fabfile.org) for their deployments. Plush versions 1.0 and greater expect Fabric 3.2.2 and greater. In a project that uses Fabric, install Plush by running:
```
pip install plush-fabric
```
To get started, see the fabfile.py in this repo for a minimal usage of Plush. For a more complete example, see my [BaseDjangoAngular template](https://github.com/kbarnes3/BaseDjangoAngular).
Raw data
{
"_id": null,
"home_page": null,
"name": "plush-fabric",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "Fabric, GitHub, deployment",
"author": null,
"author_email": "Kevin Barnes <kbarnes3@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/15/b0/d69af6de9795437cdc69b90d92a038b124c46b8585ae82dff47fbc9b9ca2/plush_fabric-1.0.9.tar.gz",
"platform": null,
"description": "Plush\n==============\n\nA helper library for [Fabric](https://www.fabfile.org) to simplify creating and managing GitHub deploy keys when deploying your GitHub-hosted\nrepository. Currently, Plush is only tested on Ubuntu 24.04 LTS.\n\nPlush aims to make deployments easier by:\n- Using OAuth flows to securely connect to the GitHub API on your behalf\n(while supporting 2 factor auth and never handling your username/password)\n- Generating SSH deploy keys on your target server/computer\n- Registering these deploy keys with your GitHub repo programmatically\n- Configuring your new clone to use the appropriate deploy key while not conflicting with other \nSSH keys used elsewhere on your server\n- ACL'ing these keys so they can be reused by people to fetch/deploy on your behalf\n(and not readable by anyone else on the server)\n- Example PowerShell scripts are provided that give tab completion around fab.exe\n\nTo see this project in action, follow the directions in Setup-Dev-Environment.md. You will need access to an Ubuntu 24.04 machine (ideally a VM).\n\n## Usage\n\nThis project is intended to be used by projects that use or are considering [Fabric](https://www.fabfile.org) for their deployments. Plush versions 1.0 and greater expect Fabric 3.2.2 and greater. In a project that uses Fabric, install Plush by running:\n\n```\npip install plush-fabric\n```\n\nTo get started, see the fabfile.py in this repo for a minimal usage of Plush. For a more complete example, see my [BaseDjangoAngular template](https://github.com/kbarnes3/BaseDjangoAngular).\n",
"bugtrack_url": null,
"license": null,
"summary": "Helper library for Fabric to simplify creating and managing GitHub deploy keys when deploying GitHub-hosted repositories",
"version": "1.0.9",
"project_urls": {
"Homepage": "https://github.com/kbarnes3/Plush",
"Issues": "https://github.com/kbarnes3/Plush/issues"
},
"split_keywords": [
"fabric",
" github",
" deployment"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "98b11fcc1d6bee7dc9bb0608f214b707922d3c38e4b0aeb3f9e4f31fb47e4257",
"md5": "dee5c68e24876432736a65a4765298c0",
"sha256": "a481a5713ab5c9c12f57be4b8f3705db185e25f7708355852459446d47859fee"
},
"downloads": -1,
"filename": "plush_fabric-1.0.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dee5c68e24876432736a65a4765298c0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 14099,
"upload_time": "2025-01-02T02:41:45",
"upload_time_iso_8601": "2025-01-02T02:41:45.003689Z",
"url": "https://files.pythonhosted.org/packages/98/b1/1fcc1d6bee7dc9bb0608f214b707922d3c38e4b0aeb3f9e4f31fb47e4257/plush_fabric-1.0.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "15b0d69af6de9795437cdc69b90d92a038b124c46b8585ae82dff47fbc9b9ca2",
"md5": "bba6cd310ac631689c8b8beb5ef662b0",
"sha256": "5c4766b41e6717fa168cceb133d838767427862bc502f7973a5875a68a0e61ba"
},
"downloads": -1,
"filename": "plush_fabric-1.0.9.tar.gz",
"has_sig": false,
"md5_digest": "bba6cd310ac631689c8b8beb5ef662b0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 12675,
"upload_time": "2025-01-02T02:41:47",
"upload_time_iso_8601": "2025-01-02T02:41:47.492731Z",
"url": "https://files.pythonhosted.org/packages/15/b0/d69af6de9795437cdc69b90d92a038b124c46b8585ae82dff47fbc9b9ca2/plush_fabric-1.0.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-02 02:41:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kbarnes3",
"github_project": "Plush",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "plush-fabric"
}
