Skip to content

Installing Moonshot for User Interface

Dependencies needed for installation

This project strictly requires Python 3.11. Ensure that you have Python 3.11 installed on your system before proceeding with installation and usage.

Software Version Requirement
Python v3.11
NodeJs v20.11.1 LTS or above
npm v10.8.0 or above
git

Install Moonshot

Run the following command in a virtual environment of your choice:

$ pip install "aiverify-moonshot[all]"

Once installed, Moonshot provides commands to download all the test assets required to start testing your AI system:

$ python -m moonshot -i moonshot-data -i moonshot-ui

Run Moonshot UI with the following command:

$ python -m moonshot web

Lastly, access Moonshot UI using a browser (http://localhost:3000).

Extra Resources

Setting up Virtual Environment

It is recommended to create a new Python virtual environment in your working directory before proceeding with installation. To do so, enter working directory and proceed with following steps:

$ python -m venv venv
$ venv/Scripts/Activate.ps1
$ python -m venv venv
$ venv/Scripts/activate.bat
$ python -m venv venv
$ source venv/bin/activate

Specifying Custom Environment File

If you have a custom '.env' file, specify the path to the file as follows:

python -m moonshot -e /path/to/your/.env