Metadata-Version: 2.1
Name: plush-fabric
Version: 0.5.2
Summary: Helper library for Fabric to simplify creating and managing GitHub deploy keys when deploying GitHub-hosted repositories
Home-page: https://github.com/kbarnes3/Plush
Author: Kevin Barnes
Author-email: kbarnes3@gmail.com
License: BSD
Keywords: fabric github deployment
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Requires-Dist: oauth2client (>=3.0.0)
Requires-Dist: PyGithub (>=1.3.8)
Requires-Dist: keyring (>=12.0.0)
Requires-Dist: fabric (>=2.5.0)
Requires-Dist: patchwork (>=1.0.1)

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 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 <https://www.fabfile.org>`_ 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 <https://github.com/kbarnes3/Plush>`_ for a minimal usage of Plush.
For a more complete example, see my `BaseDjangoAngular template <https://github.com/kbarnes3/BaseDjangoAngular>`_.


