Installation

There are two ways to use GraphDonkey. The first is via downloading the executable and the second is via using it as a repository. There are pros and cons to each method, so I suggest you read the following sections carefully.

Important Note

Do not, under no circumstance, run GraphDonkey as administrator/root user. This is never a requirement for any functionality you require. Please ask moderators on this page what to do if you run into issues with your system.

Editing files that require administrator/root user access is therefore discouraged and should not be done.

GraphDonkey cannot break your system setup if you use it in its intended way. Therefore, there is no responsibility if your setup was changed unintentionally.

Downloading the executable

If you know nothing about programming, or don't want to install any additional packages, it is best you download the executable (either from zip, or tarball). Inside, you can find a GraphDonkey directory that contains a lot of files. Somewhere in there, there is a GraphDonkey executable that launches the application (either from the commandline, or from a file browser).

Note: At this current point in time, this is available for Linux and Windows users. Potentially, it can also be executed on a Mac, but I cannot confirm this statement. If this doesn't work, or if you have created your own distribution, please let me know.

Using the repository

If you cannot use the executable (for one reason or another), or if you prefer having more flexibility over the code, or if you want to contribute (see this page), you can always clone this repository. From there, all you have to do is install the requirements (see below) and run __main__.py with python 3 (this may be done in a virtual environment).

Note: Only do this if you know what you're doing. I'm not responsible for any misconfiguration of your system.

Note: Cloning the repo should allow for a working app, but this is no guarantee. To be certain, please revert to the latest tag (version number, preceded with the letter v) on the master branch.

Requirements

See also requirements.txt.

• PyQt5
• lark-parser
• chardet
• markdown (for displaying plugin info in preferences)
• pytest (for testing purposes only)
• pyinstaller (for bundling)
  • You can bundle GraphDonkey using the install.bat (Windows) and install.sh (Linux) files.