Skip to content

Prerequisites

grenston edited this page Nov 5, 2020 · 6 revisions

You can run the tool as Docker Container or cli using Python. Refer to the below sections in both cases.

  • A GitHub organization with permissions to update the branch protection rules
  • Git installed on your machine.Click here to get the latest version of Git.

Run as a Docker Container 🐳

  • Docker installed on your machine

Run using Python 🐍

  • Python 3.8 or above installed on your machine

  • Install the latest version of pip

    python -m pip install --upgrade pip

  • Install the Python library stdiomask

    pip install stdiomask

  • Install the Python library PyGithub

    pip install pygithub

Note ⚠️ Run the above commands as a root user (linux) or as an administrator mode in command prompt (windows).

Once the prerequisites are met you are ready to start configuring the tool.