Helper library for Fabric to simplify creating and managing GitHub deploy keys when deploying GitHub-hosted repositories
Project description
Plush
A helper library for Fabric to simplify creating and managing GitHub deploy keys when deploying your GitHub-hosted repository. Currently, Plush is only tested on Ubuntu 22.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 18.04 machine (ideally a VM).
Usage
This project is intended to be used by projects that use or are considering Fabric for their deployments. Plush expects Fabric 2.0 or greater. In a project that uses Fabric, install Plush by running:
pip install plush-fabric
To get started, see the fabfile.py
in the GitHub repo for a minimal usage of Plush.
For a more complete example, see my BaseDjangoAngular template.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for plush_fabric-0.5.14-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c054be32304e345e3e48aaf248c76d816ef5daf17516e79aded50b60b57b9025 |
|
MD5 | f4a8e28cc24c9e12787c78f9858e8393 |
|
BLAKE2b-256 | f05b08a9680ad635098f350c6f8ae7acc6b93e6433fb2f599c088ba25d30963d |