The Animal

automate GHES... like an animal

IMPORTANT

This is an experimental project. It is neither supported nor endorsed by GitHub. Use it at your own risk.

Purpose

The Animal is a command-line tool with which you can automate GHES through its web UI.

This can be useful when you can't do the same thing through its API, or for testing.

Features

• Create and return a classic PAT
• Create an organization
• Create a GitHub App

Limitations

• Currently only works with GHES
• Currently does not work on GHEC
• Currently does not work on github.com

Requirements

• Selenium Server
• Python 3.11.2
• Python packages listed in requirements.txt

Installation

brew install selenium-server
python3 -m venv venv
. ./venv/bin/activate
pip3 install -r requirements.txt

Configuration

cp etc/example.toml etc/my-ghes-test.toml
vi etc/my-ghes-test.toml

Usage

Usage: animal [OPTIONS]

  automate GHES... like an animal

Options:
  --config-file PATH              [required]
  --url URL                       Overrides config file
  --username USERNAME             Overrides config file
  --password PASSWORD             Overrides config file
  --debug
  --create [classic-pat|github-app|org]
  --help                          Show this message and exit.

Examples

Create a classic PAT

./animal --config-file etc/my-ghes-test.toml --create classic-pat

Create a github-app

./animal --config-file etc/my-ghes-test.toml --create github-app

Create an organization

./animal --config-file etc/my-ghes-test.toml --create org

Create a classic PAT, with debugging turned on

./animal --config-file etc/my-ghes-test.toml --create classic-pat --debug

Changelog

• 2022-02-26 - documentation improvements
• 2022-02-25 - documentation improvements
• 2022-02-25 - added: LICENSE.txt, SECURITY.md, SUPPORT.md, CODE_OF_CONDUCT.md
• 2022-02-23 - gracefully handling unexpected web pages
• 2022-02-23 - validating URLs before using them
• 2022-02-23 - gracefully erroring out when given incorrect username/password
• 2022-02-23 - added command line options: --url, --username, --password
• 2022-02-22 - documentation fixes
• 2022-02-21 - new option: --create org
• 2022-02-21 - renamed --get to --create
• 2022-02-20 - initial release

Tested

create classic-pat

Python	GHES
3.11.2	3.7.6
3.11.2	3.8.0

create org

Python	GHES
3.11.2	3.7.6
3.11.2	3.8.0

create app

Python	GHES
3.11.2	3.8.0

Contributions

We warmly welcome contributions to improve this project. Please see CONTRIBUTING for how to get involved.

Support

If you need support using this project, have questions about it, or need to report security issues, please open up an issue in this repository.

The Animal is NOT supported by GitHub.

License

This project is licensed under the terms of the MIT open source license. Please refer to LICENSE for the full terms.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Maintainers

The Animal is maintained by @mokshadharma