Update version to 0.5.2 and enhance installation instructions in README
All checks were successful
Gitea/kapitanbooru-uploader/pipeline/head This commit looks good

This commit is contained in:
2025-03-15 23:45:56 +01:00
parent 56640942c8
commit 0978dd8e3c
5 changed files with 40 additions and 22 deletions

View File

@@ -12,25 +12,47 @@ Kapitanbooru Uploader is a GUI application for uploading images to KapitanBooru.
## Installation
1. Clone the repository:
```sh
git clone https://git.mlesniak.pl/kapitan/kapitanbooru-uploader.git
cd kapitanbooru-uploader
```
2. Install the required dependencies:
```sh
pip install -r requirements.txt
2. **Standard Installation (Supports most NVIDIA GPUs):**
```bash
pip install .
```
3. **For RTX 50xx (Blackwell GPUs) with CUDA 12 Nightly Support:**
Requires the `cuda12-nightly` extra and PyTorch nightly binaries:
```bash
pip install ".[cuda12-nightly]" --extra-index-url https://download.pytorch.org/whl/nightly/cu128 --pre
```
Using `pipx` for isolated installation:
```bash
pipx install "kapitanbooru-uploader[cuda12-nightly]" --pip-args "--extra-index-url https://download.pytorch.org/whl/nightly/cu128 --pre"
```
3. Ensure you have the required Python version:
4. Verify Python version:
```sh
python --version
# Should be >= 3.13
```
⚠️ **Notes:**
- The `cuda12-nightly` extra depends on pre-release PyTorch packages from the specified index.
- Private PyPI repository (for `wdtagger[cuda12-nightly]`) must already be configured in your environment (no URL needed here).
## Usage
1. Run the application:
```sh
python -m kapitanbooru_uploader.main
```
@@ -45,13 +67,6 @@ Configuration settings can be found in the `settings.json` file located in the a
## Development
### Running Tests
To run tests, use the following command:
```sh
pytest
```
### Debugging
You can use the provided VSCode launch configurations to debug the application. Open the `.vscode/launch.json` file and select the appropriate configuration.