setup_guide.md

1. Setup Guide

---

1.1 Installation from PyPI

⚠️ Requires Python Version 3.10+

1.1.1 Installation

Install the twidgets package and all its dependencies directly from PyPI using one simple command:

pip install twidgets

1.1.2 Initialize Configuration

Run the following command in your terminal:

twidgets init

1.1.3 Run the Dashboard

Start the application by executing the entry point command:

twidgets

---

1.2 Installation from Source

⚠️ Requires Python Version 3.10+

1.2.1 Cloning this repository

1. Open a terminal and navigate to the folder where you want the project.
2. Clone the repository using:

git clone https://github.com/IceWizard7/terminal-widgets.git
cd terminal-widgets

1.2.2 Install dependencies

Run the following command in your project folder:

pip install -r requirements-dev.txt

1.2.3 Initialize Configuration

Run the following command in your project folder:

python -m twidgets init

1.2.4 Run the dashboard

Start the application:

python -m twidgets