https://github.com/hardmax71/qtutorial
A lightweight, interactive tutorial system for PySide6 applications.
https://github.com/hardmax71/qtutorial
gui pyqt6 pyside6 python tutorial
Last synced: 3 months ago
JSON representation
A lightweight, interactive tutorial system for PySide6 applications.
- Host: GitHub
- URL: https://github.com/hardmax71/qtutorial
- Owner: HardMax71
- License: mit
- Created: 2024-08-25T19:06:44.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-27T16:57:09.000Z (over 1 year ago)
- Last Synced: 2024-12-28T14:19:52.923Z (about 1 year ago)
- Topics: gui, pyqt6, pyside6, python, tutorial
- Language: Python
- Homepage:
- Size: 2.2 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# QTutorial
A lightweight, interactive tutorial system for PySide6 applications.
## Description
QTutorial provides an easy way to add step-by-step tutorials to your PySide6 apps. It features element highlighting,
responsive hint positioning, and customizable tutorial steps.
The following sequence diagram illustrates the core workflow of QTutorial:
## Features
- Interactive tutorial overlay
- UI element highlighting
- Step-by-step guidance
- Customizable tutorial steps
- Responsive hint positioning
- Keyboard navigation support
## Requirements
- Python 3.10+
- PySide6
Installation Guide
1. Clone this repository:
```bash
git clone https://github.com/HardMax71/qtutorial.git
```
2. Navigate to the project directory:
```bash
cd qtutorial
```
3. Create a virtual environment:
```bash
python -m venv venv
```
4. Activate the virtual environment:
- On Windows:
```bash
venv\Scripts\activate
```
- On macOS and Linux:
```bash
source venv/bin/activate
```
5. Install the required packages:
```bash
pip install requirements.txt # or pip install PySide6
```
6. Run the application:
```bash
python main.py
```
The application will start with the tutorial mode automatically activated.
## Customization
To customize the tutorial:
1. Modify the `tutorial_steps` list in the `MainWindow` class.
2. Adjust the UI layout in the `MainWindow` class.
3. Customize styles by editing the QSS files:
- `tutorial_hint.qss`: Style for the tutorial hint box
- `highlight.qss`: Style for highlighted elements
- `start_style.qss`: General application style
## Project Structure
```plaintext
qtutorial/
│
├── files/
│ └── example.gif
├── qtutorial/
│ ├── styles/
│ │ ├── highlight.qss
│ │ └── tutorial_hint.qss
│ ├── icons/
│ | ├── back-button.png
│ | └── ...
│ ├── init.py
│ ├── hint.py
│ ├── tutorial_manager.py
│ └── utils.py
├── .gitignore
├── LICENSE
├── main.py
├── README.md
└── start_style.qss
```
- `files/`: Contains additional resources
- `example.gif`: Demonstration of the tutorial system
- `qtutorial/`: Core package of the tutorial system
- `styles/`: QSS stylesheets for the tutorial components
- `icons/`: Icon resources
- `__init__.py`: Package initializer
- `hint.py`: Implements the tutorial hint widget
- `tutorial_manager.py`: Manages the tutorial flow
- `utils.py`: Utility functions including stylesheet loading
- `main.py`: Main application script
- `start_style.qss`: General application stylesheet
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## License
This project is open source and available under the [MIT License](LICENSE).