Installation

GraphSpy can be installed in several ways. As long as you have Python3 available, it should run fine on any operating system.

Recommended installation (pipx)

The following syntax should allow you to install GraphSpy on every operating system and make it available from your command line globally.

Using pipx will ensure that there are no dependency conflicts.

# Install pipx (skip this if you already have it)
python3 -m pip install pipx
python3 -m pipx ensurepath

# Install the latest version of GraphSpy from pypi
python3 -m pipx install graphspy
# OR
# Install the latest version of GraphSpy from Github
python3 -m pipx install git+https://github.com/RedByte1337/GraphSpy

After installation, GraphSpy can easily be executed from any location.

graphspy -h

pip

At this point in time, GraphSpy does not have very strict dependency requirements, so pip should work fine in most use cases as well. However, if you do encounter dependency conflicts when installing with pip directly, then you are on your own!

# Install the latest version of GraphSpy from pypi
python3 -m pip install graphspy
# OR
# Install the latest version of GraphSpy from Github
python3 -m pip install git+https://github.com/RedByte1337/GraphSpy

After installation, GraphSpy can easily be executed from any location.

graphspy -h

Run from source

If you don't want to install GraphSpy on your system, you can also just clone the repository locally and execute it directly from there.

# Navigate to the directory where you want to clone the repository
cd /opt
# Clone the latest version from GitHub
git clone https://github.com/RedByte1337/GraphSpy.git
# Install the requirements manually
cd GraphSpy
python3 -m pip install -r requirements.txt

After installing the requirements, GraphSpy can be executed directly with Python.

# Yes, that is a lot of GraphSpy in one path.
python3 /opt/GraphSpy/GraphSpy/GraphSpy.py -h