Skip to content

README.ko-KR.md

Latest commit

 

History

History
116 lines (88 loc) · 5.4 KB

README.ko-KR.md

File metadata and controls

116 lines (88 loc) · 5.4 KB
Raw

WaifuBoard

English README | 简体中文 README | 繁體中文 README | 日本語 README | 한국어 README

이미지 보드 사이트(예: Danbooru, Safebooru, Yandere)에서 이미지, 태그 및 메타데이터를 비동기로 다운로드하기 위한 API입니다. 이미 다운로드한 파일은 무시합니다.

설치

pip install waifuboard

요구 사항: Python >= 3.10

지원 플랫폼 및 기능

플랫폼 게시물(다운로드) 풀(다운로드)
Danbooru ✅ ✅
Safebooru ✅ ❌
Yandere ✅ ✅
기타 플랫폼 ... ...

사용 방법

클라이언트를 생성(예: DanbooruClient)하고, client.posts.download(...) 또는 client.pools.download(...)처럼 해당 컴포넌트의 다운로드 메서드를 호출하세요. 매개변수는 코드의 다운로드 메서드 docstring을 참고하세요.

import asyncio
import logging

from waifuboard import DanbooruClient


async def main():
	# API와 상호작용할 클라이언트를 생성
	client = DanbooruClient(
        directory="./downloads",  # 현재 클라이언트 플랫폼의 파일 저장 루트 디렉터리
        logger_level=logging.INFO,  # 로그 레벨
        base_url=None,  # 각 요청에 URL 접두사(또는 base url)를 자동으로 설정 (해당되는 경우)
        proxies="http://127.0.0.1:7897",  # 프로토콜 또는 프로토콜과 호스트를 프록시 URL에 매핑하는 딕셔너리 (예: {'http': 'foo.bar:3128', 'http://host.name': 'foo.bar:4012'}). 각 요청에 적용됨. 단일 문자열이 제공되면 http와 https 모두에 사용됨. 위 두 타입의 튜플도 가능하며 요청마다 그 중 하나가 무작위로 선택됨. 제공되지 않고 trust_env가 True이면 프로세스 환경의 프록시 설정이 기본값으로 캡처되어 최종 우선순위는 request > session > env가 됨
        retries=5,  # 요청 포기 전 자동 재시도 횟수
        max_attempt_number=3,  # 요청 메서드의 기본 외부 재시도 예산(tenacity 레벨). 요청 메서드가 자체 max_attempt_number를 전달하지 않을 때 사용됨. 요청 시점에도 여전히 None이면 내부 호출이 단일 시도로 폴백됨
        rate_limit=10.0,  # 초당 최대 요청 수
        timeout=None,  # 기본 타임아웃 설정. 공개 메서드에서 타임아웃이 제공되지 않은 경우 사용됨
    )

	# 게시물 다운로드
	await client.posts.download(
		limit=200,
		all_page=True,
		tags="k-on!",
		save_raws=True,
		save_tags=True,
	)

	# 풀 다운로드
	await client.pools.download(
		limit=1000,
		query={
			'search[name_matches]': 'k-on!',
		},
		all_page=True,
		save_raws=True,
		save_tags=True,
	)


if __name__ == "__main__":
	asyncio.run(main())

이 프로젝트가 도움이 되었다면, 작은 별(Star)이 제가 오픈소스를 지속하는 변함없는 원동력이 됩니다.

다운로드 디렉터리 구조

디렉터리 트리:

{directory}/
└─ {Platform}/
	└─ {Component}/
		└─ task/
			├─ images/
			│  └─ ...
			├─ tags/
			│  └─ ...
			└─ raws/
				└─ ...

task는 다운로드 작업의 고유 식별자입니다(예: 게시물 ID, 풀 ID).

기여

기여를 환영합니다. 새 플랫폼이나 기능을 추가하려면:

  • 아키텍처

    • 플랫폼은 waifuboard.booru.Booru(• 기본 클라이언트)를 상속하고, 적절한 base_url과 컴포넌트를 설정하세요.
    • 기능/엔드포인트(예: Posts, Pools)는 waifuboard.booru.BooruComponent(• 기본 컴포넌트)를 상속하고, 기존 플랫폼과 일관된 download(...) 인터페이스를 구현하세요.
    • Booru의 도우미(concurrent_fetch_page, concurrent_download_file, concurrent_save_raws, concurrent_save_tags)를 재사용하세요.

  • GitHub 워크플로우

    1. 이 저장소를 포크하세요.
    2. 변경 사항을 위한 새 브랜치를 만드세요: git checkout -b feat/<short-name>.
    3. 플랫폼/컴포넌트를 구현하고, 이 README에 최소한의 문서를 추가하세요.
    4. 기본 기능이 동작하는지 빠르게 로컬 테스트하세요.
    5. 브랜치를 커밋하고 푸시하세요: git push origin feat/<short-name>.
    6. main으로 풀 리퀘스트를 열고, 무엇/왜/테스트 방법을 간단히 설명하세요.

가이드라인

  • 공개 API를 기존과 일관되게 유지하세요(메서드명, 매개변수, 반환값).
  • 새로운 메서드에는 docstring을 추가하세요. 특히 download(...)의 매개변수와 동작을 명시하세요.
  • 기존 코드 스타일과 로깅 방식을 따르세요.
  • 파괴적인 변경은 피하세요. 불가피하다면 PR에서 명확히 밝혀주세요.