Installation and Usage - Ktiseos-Nyx/Dataset-Tools GitHub Wiki

This guide will walk you through cloning the repository, setting up a recommended virtual environment, installing dependencies, and running Dataset-Tools.

Begin by opening your preferred terminal or command-line interface. This could be:

• Windows: PowerShell, Command Prompt (cmd)
• macOS: Terminal, zsh, bash
• Linux: bash, zsh, or any other shell you use. 🐣

Use git to clone the Dataset-Tools repository to your local machine:

git clone https://github.com/Ktiseos-Nyx/Dataset-Tools.git

After cloning, navigate into the newly created directory:

cd Dataset-Tools

Using a virtual environment is highly recommended. It isolates the project's dependencies, preventing conflicts with other Python projects or your global Python installation. This keeps your setup clean and manageable.

A. Using Python's built-in venv module:

1. Create the virtual environment (replace <env_name> with your preferred name, e.g., .venv):

python3 -m venv <env_name>

2. Activate the virtual environment:

• Linux/macOS (bash/zsh):

source <env_name>/bin/activate

• Linux/macOS (fish shell):

source <env_name>/bin/activate.fish

• Windows (PowerShell):

.\<env_name>\Scripts\Activate.ps1

• Windows (Command Prompt):

.\<env_name>\Scripts\Activate.ps1

(Your terminal prompt should change to indicate the active environment.)

B. Using uv (if you have it installed):

1. Create and activate the virtual environment (this example uses Python 3.12, uv will attempt to find a suitable Python):

uv venv .venv 
# Example output:
# Using Python 3.12.3
# Creating virtual environment at: .venv

2. Activate the environment:

• Linux/macOS (bash/zsh):

source .venv/bin/activate

• Linux/macOS (fish shell):

source <env_name>/bin/activate.fish

• Windows (PowerShell):

.\<env_name>\Scripts\Activate.ps1

• Windows (Command Prompt):

.\<env_name>\Scripts\Activate.ps1

Once your virtual environment is active (if you chose to use one), install the required Python packages.

• Using pip (standard Python installer):

pip install .

(This command installs the package in editable mode based on pyproject.toml or setup.py in the current directory.)

• Using uv:

uv pip install .

With the dependencies installed, you can now launch Dataset-Tools:

dataset-tools

You're in!

The Dataset-Tools application should now open.