{"id":18728559,"url":"https://github.com/hardmax71/qtutorial","last_synced_at":"2025-11-12T04:30:22.508Z","repository":{"id":254749258,"uuid":"847418528","full_name":"HardMax71/qtutorial","owner":"HardMax71","description":" A lightweight, interactive tutorial system for PySide6 applications.","archived":false,"fork":false,"pushed_at":"2024-08-27T16:57:09.000Z","size":2311,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-12-28T14:19:52.923Z","etag":null,"topics":["gui","pyqt6","pyside6","python","tutorial"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/HardMax71.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-25T19:06:44.000Z","updated_at":"2024-09-07T13:10:07.000Z","dependencies_parsed_at":"2024-08-27T18:14:39.126Z","dependency_job_id":null,"html_url":"https://github.com/HardMax71/qtutorial","commit_stats":null,"previous_names":["hardmax71/qtutorial"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HardMax71%2Fqtutorial","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HardMax71%2Fqtutorial/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HardMax71%2Fqtutorial/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HardMax71%2Fqtutorial/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/HardMax71","download_url":"https://codeload.github.com/HardMax71/qtutorial/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239599040,"owners_count":19665911,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["gui","pyqt6","pyside6","python","tutorial"],"created_at":"2024-11-07T14:21:51.690Z","updated_at":"2025-11-12T04:30:22.450Z","avatar_url":"https://github.com/HardMax71.png","language":"Python","readme":"\u003cdiv align=\"center\"\u003e\n\n# QTutorial\n\nA lightweight, interactive tutorial system for PySide6 applications.\n\n\u003cimg src=\"./files/example.gif\" alt=\"QTutorial Example\" width=\"600\"/\u003e\n\n\u003c/div\u003e\n\n## Description\n\nQTutorial provides an easy way to add step-by-step tutorials to your PySide6 apps. It features element highlighting,\nresponsive hint positioning, and customizable tutorial steps.\n\nThe following sequence diagram illustrates the core workflow of QTutorial:\n\n\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"./files/sequence_diagram.png\" alt=\"QTutorial Sequence Diagram\" width=\"600\"/\u003e\n\u003c/div\u003e\n\n## Features\n\n- Interactive tutorial overlay\n- UI element highlighting\n- Step-by-step guidance\n- Customizable tutorial steps\n- Responsive hint positioning\n- Keyboard navigation support\n\n## Requirements\n\n- Python 3.10+\n- PySide6\n\n\u003cdetails\u003e\n\u003csummary\u003eInstallation Guide\u003c/summary\u003e\n\n1. Clone this repository:\n   ```bash\n   git clone https://github.com/HardMax71/qtutorial.git\n    ```\n\n2. Navigate to the project directory:\n    ```bash\n    cd qtutorial\n    ```\n\n3. Create a virtual environment:\n   ```bash\n   python -m venv venv\n   ```\n\n4. Activate the virtual environment:\n    - On Windows:\n   ```bash\n     venv\\Scripts\\activate\n   ```\n    - On macOS and Linux:\n   ```bash\n      source venv/bin/activate\n   ```\n\n5. Install the required packages:\n\n   ```bash\n   pip install requirements.txt # or pip install PySide6\n   ```\n\n6. Run the application:\n   ```bash\n    python main.py\n    ```\n\nThe application will start with the tutorial mode automatically activated.\n\n\u003c/details\u003e\n\n## Customization\n\nTo customize the tutorial:\n\n1. Modify the `tutorial_steps` list in the `MainWindow` class.\n2. Adjust the UI layout in the `MainWindow` class.\n3. Customize styles by editing the QSS files:\n    - `tutorial_hint.qss`: Style for the tutorial hint box\n    - `highlight.qss`: Style for highlighted elements\n    - `start_style.qss`: General application style\n\n## Project Structure\n\n```plaintext\nqtutorial/\n│\n├── files/\n│   └── example.gif\n├── qtutorial/\n│   ├── styles/\n│   │   ├── highlight.qss\n│   │   └── tutorial_hint.qss\n│   ├── icons/\n│   |   ├── back-button.png\n│   |   └── ...\n│   ├── init.py\n│   ├── hint.py\n│   ├── tutorial_manager.py\n│   └── utils.py\n├── .gitignore\n├── LICENSE\n├── main.py\n├── README.md\n└── start_style.qss\n```\n\n- `files/`: Contains additional resources\n  - `example.gif`: Demonstration of the tutorial system\n- `qtutorial/`: Core package of the tutorial system\n  - `styles/`: QSS stylesheets for the tutorial components\n  - `icons/`: Icon resources\n  - `__init__.py`: Package initializer\n  - `hint.py`: Implements the tutorial hint widget\n  - `tutorial_manager.py`: Manages the tutorial flow\n  - `utils.py`: Utility functions including stylesheet loading\n- `main.py`: Main application script\n- `start_style.qss`: General application stylesheet\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n## License\n\nThis project is open source and available under the [MIT License](LICENSE).","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhardmax71%2Fqtutorial","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhardmax71%2Fqtutorial","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhardmax71%2Fqtutorial/lists"}