| Name | plush-fabric JSON |
| Version |
1.0.10
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-02-20 03:02:58 |
| 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/9e/07/7bbefdf6e11309b9d9e44b17469a1bc779b53b26e0789833c26bdd9bc797/plush_fabric-1.0.10.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.10",
"project_urls": {
"Homepage": "https://github.com/kbarnes3/Plush",
"Issues": "https://github.com/kbarnes3/Plush/issues"
},
"split_keywords": [
"fabric",
" github",
" deployment"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "3e3b7c7fb0a59b3ed93b15367be5e3f4dc99a83263b18668203d43c47a9961a6",
"md5": "fb824d339d149e73c40c077e454288b0",
"sha256": "03af2544dbaf565d20318df7ac850cd4e408ff83167acc5c3be9e48c782e44a3"
},
"downloads": -1,
"filename": "plush_fabric-1.0.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fb824d339d149e73c40c077e454288b0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 14108,
"upload_time": "2025-02-20T03:02:56",
"upload_time_iso_8601": "2025-02-20T03:02:56.425151Z",
"url": "https://files.pythonhosted.org/packages/3e/3b/7c7fb0a59b3ed93b15367be5e3f4dc99a83263b18668203d43c47a9961a6/plush_fabric-1.0.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "9e077bbefdf6e11309b9d9e44b17469a1bc779b53b26e0789833c26bdd9bc797",
"md5": "f5c9be96a4c17f5bb19f09e32b839494",
"sha256": "bfdcb9b5e1140bc05ca29813ae80c312fcb75b8a111644459cc07562505ed62a"
},
"downloads": -1,
"filename": "plush_fabric-1.0.10.tar.gz",
"has_sig": false,
"md5_digest": "f5c9be96a4c17f5bb19f09e32b839494",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 12700,
"upload_time": "2025-02-20T03:02:58",
"upload_time_iso_8601": "2025-02-20T03:02:58.457286Z",
"url": "https://files.pythonhosted.org/packages/9e/07/7bbefdf6e11309b9d9e44b17469a1bc779b53b26e0789833c26bdd9bc797/plush_fabric-1.0.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-20 03:02:58",
"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"
}
