Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,11 @@ curl -X POST http://localhost:8000/api/queue/download/artwork/{artwork-id-here}

If `PIXIVUTIL_SERVER_API_KEY` is not set (or is empty), API key authentication is disabled. If it is set, the request above needs an `Authorization: Bearer <your-api-key>` header.

An nginx [configuration file](/nginx/default.conf) is attached for your reverse proxy reference.
An nginx [configuration file](nginx/default.conf) is attached for your reverse proxy reference.

### API Reference

#### [Database](/docs/api/database.md)
#### [Database](docs/api/database.md)

Endpoints to get metadata from the PixivUtil2 database.

Expand All @@ -47,11 +47,11 @@ For example, the server supports the following endpoints:
- Get tag metadata by ID
- Get series metadata by ID

#### [Dead letter queue (DLQ)](/docs/api/dlq.md)
#### [Dead letter queue (DLQ)](docs/api/dlq.md)

API endpoints to inspect, replay, and purge failed worker messages in the dead letter queue.

#### [Download queueing](/docs/api/download.md)
#### [Download queueing](docs/api/download.md)

API endpoints to queue content (artwork) downloads for worker from server.

Expand All @@ -64,21 +64,21 @@ The following jobs are supported via PixivUtil server API:

All queue endpoints accept an optional `priority` query parameter (`1`-`3`, where `3` is highest). Defaults are chosen per endpoint so that cheap single-artwork requests outrank long bulk crawls.

#### [Health](/docs/api/health.md)
#### [Health](docs/api/health.md)

Health-related API endpoints, such as healthcheck for Docker containers.

#### [Metadata queueing](/docs/api/metadata.md)
#### [Metadata queueing](docs/api/metadata.md)

API endpoints to queue metadata downloads for worker from server. Metadata includes artist, artwork, series, and tag.

This is helpful when you have an artwork downloaded, but it's old/outdated and you want to re-fetch only the metadata.

#### [Metrics](/docs/api/metrics.md)
#### [Metrics](docs/api/metrics.md)

Prometheus metrics endpoint, covering database counts, disk and system usage, queue/DLQ depth, and HTTP request statistics.

#### [Server](/docs/api/server.md)
#### [Server](docs/api/server.md)

Server-related API endpoints, such as get cookie, update cookie, delete database, and delete downloads.

Expand Down Expand Up @@ -171,4 +171,4 @@ The project also uses `uv` as the build runtime with `uv_build`, which significa

## PixivUtil Client

PixivUtil client is an asynchronous API client for PixivUtil server. See the client [README](/PixivUtilClient/README.md).
PixivUtil client is an asynchronous API client for PixivUtil server. See the client [README](PixivUtilClient/README.md).
2 changes: 2 additions & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# developer reference only.

volumes:
rabbitmq-data:
pixivutil-data:
Expand Down
6 changes: 3 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ license = { file = "LICENSE" }
authors = [
{ name = "psilabs-dev" }
]
version = "2.4.8"
version = "2.4.9"
dependencies = [
"aiofiles>=25.1.0",
"celery>=5.5.3",
Expand All @@ -28,13 +28,13 @@ dependencies = [
pixivutil2 = [
"beautifulsoup4>=4.9.3",
"browser-cookie3>=0.20.1",
"certifi>=2021.5.30",
"certifi>=2026.10.19",
"cloudscraper>=1.2.58",
"colorama>=0.4.4",
"curl-cffi>=0.11.3",
"demjson3>=3.0.0",
"mechanize>=0.4.5",
"pillow>=12.3.0",
"pillow>=13.0.0",
"pysocks>=1.7.1",
]

Expand Down
Loading
Loading