Welcome to King Ghidorah’s Documentation

A scripting interface for the Rodan API that allows more granular control over your projects, workflows, and resources and the three queues for RodanTasks, Python2, Python3, and core rodan. It is named for each of the 3 heads of the famous Kaiju, King Ghidorah. You may be wondering why all the examples use kd instead of kg as the abbreviation.

Installation

  • poetry install preferred method.
    • or pip install .

Usage

  • Fill in the user credentials and the Rodan API domain.
    • You can use a proxy to connect to the server too, just make sure that you replace false with the proxy information: "socks5://localhost:5000"
  • Learn by example by using the calls in the EXAMPLES.md file.
  • The config.json file should be removed from the git worktree to stop the accidental uploading of actual credentials. If you need to add more fields to it, bring it back and remove it again.
    • Remove: git update-index --skip-worktree config.json
    • Bring it back: git update-index --no-skip-worktree config.json

Codestyle

Just run yapf -ir .

Indices and tables