Skip to main content

Simple tool for autodeploying github projects

Project description

Simple auto-deployment tool based on GitHub API

Requires python >= 3.6

Getting started

# pip install githubdeployment

Then create your own deployment.json based on provided deployment.example.json.

# create deployment.py and following lines
from deployment.main import deploy
deploy('/path/to/deployment.json')

Run

# python deployment.py

deployment.json config block explained

  • working_branch - Which branch you want to pull from
  • access_token - Your access token if repository is private (if repo is not private just leave it blank ) github access tokens
  • path_to_ssh_key - Where your deployment key is placed, github deployment keys
  • repository_path - Path to root folder of your project
  • github_url - Github api which will be queried when main.py is activated github api

All config keys are mandatory, make sure all permissions are set for files and directories.

Project details


Download files

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

Source Distribution

githubdeployment-1.0.4.tar.gz (3.7 kB view hashes)

Uploaded Source

Built Distribution

githubdeployment-1.0.4-py3-none-any.whl (5.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page