Skip to main content

Helper library for Fabric to simplify creating and managing GitHub deploy keys when deploying GitHub-hosted repositories

Project description

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 18.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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for plush-fabric, version 0.5.2
Filename, size File type Python version Upload date Hashes
Filename, size plush_fabric-0.5.2-py2.py3-none-any.whl (8.6 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size plush-fabric-0.5.2.tar.gz (6.5 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page