saidbysolo/dbkr-api-python

koreanbots를 위한 비공식 API 래퍼

dbkr-api-python's Issues

UpdateGuild 메서드 관련

사실 UpdateGuild는 길드 수를 업데이트해주는건데
아무래도 복수형이 붙어서 UpdateGuilds 정도가 낫지 않을까 싶습니다.

README 오타 및 통일성

해당유저의 투표여부를 bool형식(True,False)로 반환합니다. -> 해당 유저의 투표 여부를 bool 형식(True, False)으로 반환합니다.

예제들에 있는 koreanbots 토큰 변수명(token, DBKR_token, DBKR)를 하나로 통일하는 것이 나아보입니다. (디코 봇 토큰과 헷갈리지 않게 DBKR_token이 제일 나아보입니다.)

예제의 구조를
앞쪽의 네 예제(Cogs, Bot(class), Bot(not using class), Client(on_message))를 하나로 묶고, 나머지 클래스 예제들도 예제 이름을 클래스명(ex. GetByID)으로 바꾸시는 게 좋아보입니다.
(
-예제
-UpdateGuild
-Cogs
-Bot(class)
-Bot(not using class)
-Client(on_message)
-GetByID
-CheckVote
) 식으로요.

[제안] 코드의 수정이 필요해보입니다.

현재 API의 URL인 https://api.koreanbots.cf를 모든 파일에 넣어두셨는데, 해당 url은 임시이며, 언제든 변경될 수 있습니다. 따라서 코드의 기동성이 떨어지는듯합니다. Config파일로 별도로 분리하여, 추가하시는게 좋을듯합니다.

README 관련 대소문자/띄어쓰기 수정, 예제 오류 관련

Patch note -> Patch Note가 낫지 않을까 생각합니다(뭐 표기법의 차이지만요).

핫픽스:모듈 임포트 오류 수정 -> 핫픽스: 모듈 임포트 오류 수정
으로 해두고
핫픽스일 때마다 앞에
'핫픽스: '를 붙이시는 게 낫지 않을까요?

Bot(not using class) 예제에
import dbkrpy 가 빠져있습니다.

discord(봇 서포트 디스코드) -> discord(봇 지원 디스코드 서버)
intro(봇 간단설명) -> intro(봇 소개) (공식 koreanbots 관리창 명칭입니다.)

봇개발자,카테고리는 리스트로 반환됩니다. -> 봇 개발자, 카테고리는 리스트로 반환됩니다.

README 관련 대소문자 구별/띄어쓰기, 항목 설명

checkvote 예제 -> CheckVote 예제가 더 맞아보입니다.
불러올수있는항목입니다 -> 띄어쓰기 해 주시면 좋을 것 같습니다.
불러올 수 있는 항목들 설명이 현재 GetByID밖에 없는데, CheckVote와 Page도 설명해주시면 좋을 것 같습니다.