diff --git a/.editorconfig b/.editorconfig index 32c93a6..4e5e368 100644 --- a/.editorconfig +++ b/.editorconfig @@ -12,4 +12,7 @@ indent_size = 2 indent_size = 4 [pyproject.toml] -indent_size = 4 \ No newline at end of file +indent_size = 4 + +[*.md] +trim_trailing_whitespace = false \ No newline at end of file diff --git a/.vscode/settings.json b/.vscode/settings.json index f22a50a..eaf2411 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1,26 +1,35 @@ { "python.analysis.autoImportCompletions": true, - "python.analysis.extraPaths": [".venv/lib/site-packages"], - "python.analysis.fixAll": ["source.unusedImports"], + "python.analysis.extraPaths": [ + ".venv/lib/site-packages" + ], + "python.analysis.fixAll": [ + "source.unusedImports" + ], "python.languageServer": "Pylance", "mypy-type-checker.args": [ - "--disallow-untyped-defs=True", - "--disallow-untyped-calls=True", - "--check-untyped-defs=True", - "--warn_return_any=True", - "--no-implicit-optional=True", - "--strict_optional=True", - "--ignore_missing_imports=True", - ], - "editor.defaultFormatter": "charliermarsh.ruff", - "python.useEnvironmentsExtension": true, - "terminal.integrated.persistentSessionReviveProcess": "never", - "terminal.integrated.enablePersistentSessions": false, - "terminal.integrated.hideOnStartup": "always", - "[jsonc]": { - "editor.defaultFormatter": "vscode.json-language-features" - }, - "files.exclude": { - "**/__pycache__": true - } + "--disallow-untyped-defs=True", + "--disallow-untyped-calls=True", + "--check-untyped-defs=True", + "--warn_return_any=True", + "--no-implicit-optional=True", + "--strict_optional=True", + "--ignore_missing_imports=True", + ], + "editor.defaultFormatter": "charliermarsh.ruff", + "[jsonc]": { + "editor.defaultFormatter": "vscode.json-language-features" + }, + "python.useEnvironmentsExtension": true, + "files.exclude": { + "**/__pycache__": true + }, + "terminal.integrated.persistentSessionReviveProcess": "never", + "terminal.integrated.enablePersistentSessions": false, + "terminal.integrated.hideOnStartup": "always", + "files.trimTrailingWhitespace": true, + "[markdown]": { + "files.trimTrailingWhitespace": false, + "editor.renderWhitespace": "all" + } } diff --git a/readme.md b/readme.md index 10ec607..2f1927c 100644 --- a/readme.md +++ b/readme.md @@ -1,58 +1,54 @@ # LaTaniere Launcher UI -⚠️ you need [Qt Designer](https://build-system.fman.io/qt-designer-download). +## ⚠️ Requierments + +You need [Qt6 Community Edition](https://www.qt.io/development/download-qt-installer-oss) + +You need also [Qt Designer](https://build-system.fman.io/qt-designer-download) for manipulate ui file. ## First: create virtualenv -python -m venv .venv +`python -m venv .venv` ## Second: activate your virtual environment -### Windows - -Execute in powershell: +Execute from powershell in project folder: ```powershell -.venv/bin/activate.ps1 +.\.venv\Scripts\Activate.ps1 ``` -or batch file - -```bat -.venv/bin/activate.bat -``` - -### Linux - -Execute into terminal in project folder: -`source .venv/bin/actiave` - ---- ## Third install packages -Ensure your virtual environment is active and execute these commands within it. +Ensure your virtual environment is active and execute these commands within it. +Run this command in the project (from terminal) folder to verify that the Python version matches your virtual environment. -### Using Pip +`(get-command python.exe).Path` -#### Global packages +### Installing and Using Pip + +**Install pip into your virtual environment** + +Run this command : + +`py -m pip install --upgrade pip` + +And check pip is correctly installed: + +`(get-command pip.exe).Path` + +**Install project packages** `pip install -r .\requirements.txt` -#### packages for Windows only - -`pip install -r .\windows_requirements.txt` - -### Using install.py script - -Execute `python install.py` -Note: in case if you aren't virtual environment, the script stop. - Enjoy. ## Generate resource file `rcc -g python .\resources.qrc -o .\src\resources_rc.py` -You need to give complete path of rcc: +You need to give complete path of rcc. +Example in my case: `H:\Qt\6.10.2\mingw_64\bin\rcc.exe -g python resources.qrc -o .\src\resources.py`