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
All checks were successful
Gitea/kapitanbooru-uploader/pipeline/head This commit looks good
This commit is contained in:
parent
56640942c8
commit
0978dd8e3c
37
README.md
37
README.md
@ -12,25 +12,47 @@ Kapitanbooru Uploader is a GUI application for uploading images to KapitanBooru.
|
|||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
1. Clone the repository:
|
1. Clone the repository:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
git clone https://git.mlesniak.pl/kapitan/kapitanbooru-uploader.git
|
git clone https://git.mlesniak.pl/kapitan/kapitanbooru-uploader.git
|
||||||
cd kapitanbooru-uploader
|
cd kapitanbooru-uploader
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Install the required dependencies:
|
2. **Standard Installation (Supports most NVIDIA GPUs):**
|
||||||
```sh
|
|
||||||
pip install -r requirements.txt
|
```bash
|
||||||
|
pip install .
|
||||||
```
|
```
|
||||||
|
|
||||||
3. Ensure you have the required Python version:
|
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"
|
||||||
|
```
|
||||||
|
|
||||||
|
4. Verify Python version:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
python --version
|
python --version
|
||||||
# Should be >= 3.13
|
# 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
|
## Usage
|
||||||
|
|
||||||
1. Run the application:
|
1. Run the application:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
python -m kapitanbooru_uploader.main
|
python -m kapitanbooru_uploader.main
|
||||||
```
|
```
|
||||||
@ -45,13 +67,6 @@ Configuration settings can be found in the `settings.json` file located in the a
|
|||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
### Running Tests
|
|
||||||
|
|
||||||
To run tests, use the following command:
|
|
||||||
```sh
|
|
||||||
pytest
|
|
||||||
```
|
|
||||||
|
|
||||||
### Debugging
|
### Debugging
|
||||||
|
|
||||||
You can use the provided VSCode launch configurations to debug the application. Open the `.vscode/launch.json` file and select the appropriate configuration.
|
You can use the provided VSCode launch configurations to debug the application. Open the `.vscode/launch.json` file and select the appropriate configuration.
|
||||||
|
@ -142,7 +142,7 @@ class ImageBrowser(tk.Tk):
|
|||||||
super().__init__()
|
super().__init__()
|
||||||
self.title("Kapitanbooru Uploader")
|
self.title("Kapitanbooru Uploader")
|
||||||
self.geometry("900x600")
|
self.geometry("900x600")
|
||||||
self.version = "0.5.1"
|
self.version = "0.5.2"
|
||||||
self.acknowledged_version = parse_version(self.version)
|
self.acknowledged_version = parse_version(self.version)
|
||||||
|
|
||||||
self.settings = Settings()
|
self.settings = Settings()
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
msgid ""
|
msgid ""
|
||||||
msgstr ""
|
msgstr ""
|
||||||
"Project-Id-Version: Kapitanbooru Uploader 0.5.1\n"
|
"Project-Id-Version: Kapitanbooru Uploader 0.5.2\n"
|
||||||
"Report-Msgid-Bugs-To: kapitan@mlesniak.pl\n"
|
"Report-Msgid-Bugs-To: kapitan@mlesniak.pl\n"
|
||||||
"POT-Creation-Date: 2025-03-15 19:42+0100\n"
|
"POT-Creation-Date: 2025-03-15 19:42+0100\n"
|
||||||
"Content-Type: text/plain; charset=UTF-8\n"
|
"Content-Type: text/plain; charset=UTF-8\n"
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
msgid ""
|
msgid ""
|
||||||
msgstr ""
|
msgstr ""
|
||||||
"Project-Id-Version: Kapitanbooru Uploader 0.5.1\n"
|
"Project-Id-Version: Kapitanbooru Uploader 0.5.2\n"
|
||||||
"Report-Msgid-Bugs-To: kapitan@mlesniak.pl\n"
|
"Report-Msgid-Bugs-To: kapitan@mlesniak.pl\n"
|
||||||
"POT-Creation-Date: 2025-03-15 19:42+0100\n"
|
"POT-Creation-Date: 2025-03-15 19:42+0100\n"
|
||||||
"Language: pl\n"
|
"Language: pl\n"
|
||||||
|
@ -4,23 +4,26 @@ build-backend = "setuptools.build_meta"
|
|||||||
|
|
||||||
[project]
|
[project]
|
||||||
name = "kapitanbooru-uploader"
|
name = "kapitanbooru-uploader"
|
||||||
version = "0.5.1"
|
version = "0.5.2"
|
||||||
description = "A GUI application for uploading images to KapitanBooru"
|
description = "A GUI application for uploading images to KapitanBooru"
|
||||||
authors = [
|
authors = [{ name = "Michał Leśniak", email = "kapitan@mlesniak.pl" }]
|
||||||
{name = "Michał Leśniak", email = "kapitan@mlesniak.pl"}
|
|
||||||
]
|
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"networkx==3.4.2",
|
"networkx==3.4.2",
|
||||||
"Pillow==11.1.0",
|
"Pillow==11.1.0",
|
||||||
"pywin32==309",
|
"pywin32==309",
|
||||||
"requests==2.32.3",
|
"requests==2.32.3",
|
||||||
"wdtagger[cuda12-nightly]==0.14.0",
|
"wdtagger==0.14.0",
|
||||||
"bs4==0.0.2",
|
"bs4==0.0.2",
|
||||||
"tomli==2.2.1"
|
"tomli==2.2.1",
|
||||||
]
|
]
|
||||||
requires-python = ">=3.13"
|
requires-python = ">=3.13"
|
||||||
readme = "README.md"
|
readme = "README.md"
|
||||||
license = {file = "LICENSE"}
|
license = { file = "LICENSE" }
|
||||||
|
|
||||||
|
[project.optional-dependencies]
|
||||||
|
cuda12-nightly = [
|
||||||
|
"wdtagger[cuda12-nightly]==0.14.0",
|
||||||
|
] # Pulls from private PyPI (auto-configured via env)
|
||||||
|
|
||||||
[project.scripts]
|
[project.scripts]
|
||||||
kapitanbooru-uploader = "kapitanbooru_uploader.__main__:main"
|
kapitanbooru-uploader = "kapitanbooru_uploader.__main__:main"
|
||||||
|
Loading…
x
Reference in New Issue
Block a user