# Twip
[](https://badge.fury.io/py/twip-api) [](https://pepy.tech/project/twip-api) [](https://pepy.tech/project/twip-api)
이 라이브러리는 [Twip](www.twip.kr)의 공식 라이브러리가 아니며, [Twip](www.twip.kr)에서 스트리머들에게 제공하는 Alert Box를 이용해서 도네이션, 팔로우, 호스팅 등의 이벤트에 대해서 간편하게 대응하기 위해서 만들어졌습니다.
---
## 📥 설치
```shell
pip install twip-api
```
## ✍️ Example
```py
from twip import Twip, Donate, Follow, Subscribe, Hosting, Cheer, Sound, Slotmachine
class MyTwip(Twip):
def on_ready(self):
print("Twip is ready!")
def on_donate(self, donate: Donate):
print(donate)
def on_follow(self, follow: Follow):
print(follow)
def on_subscribe(self, subscribe: Subscribe):
print(subscribe)
def on_hosting(self, hosting: Hosting):
print(hosting)
def on_cheer(self, cheer: Cheer):
print(cheer)
def on_sound(self, sound: Sound):
print(sound)
if __name__ == "__main__":
myTwip = MyTwip()
myTwip.run("your alert box id", "your twip api token")
```
더 많은 예제는 Github [example.py](https://github.com/junah201/Twip/blob/main/twip/example.py) 에서 확인하세요.
## 🔥 Events
- **on_ready** : 트윕과 처음으로 연결되었을 때
- **on_donate** : 후원, 영상후원, 슬롯머신(룰렛)
- **on_subscribe** : 구독
- **on_hosting** : 호스팅
- **on_cheer** : 비트
- **on_follow** : 팔로우
- **on_sound** : 소리
## 📖 Version
- **[0.0.7](https://pypi.org/project/twip-api/0.0.7/)** : 사운드 이벤트가 없을 때 발생하던 버그 수정
- **[0.0.8](https://pypi.org/project/twip-api/0.0.8/)** : api key를 직접 입력 받도록 수정 ([#1](https://github.com/junah201/Twip/issues/1))
- **[0.0.8.1](https://pypi.org/project/twip-api/0.0.8.1/)** : 토큰 크롤링 옵션 추가 ([#1](https://github.com/junah201/Twip/issues/1))
- **[0.0.8.2](https://pypi.org/project/twip-api/0.0.8.2/)** : 함수 이름 관련 버그 수정
- **[0.0.9](https://pypi.org/project/twip-api/0.0.9/)** : on_ready 이벤트 추가
- **[0.0.9.1](https://pypi.org/project/twip-api/0.0.9.1/)** : 크롤링된 토큰이 유효기간이 지난 후에도 계속해서 사용되던 버그 수정
- **[1.0.0](https://pypi.org/project/twip-api/1.0.0/)** : 타입 힌트 추가 및 구조 개편
## 🕮 License
- [MIT](https://github.com/junah201/Twip/blob/main/LICENSE)
## 기타문의
- Email : junah.dev@gmail.com
Raw data
{
"_id": null,
"home_page": "https://github.com/junah201/Twip",
"name": "twip-api",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3",
"maintainer_email": "",
"keywords": "twip,twip.kr,twitch",
"author": "Junah201",
"author_email": "junah.dev@gmail.com",
"download_url": "",
"platform": null,
"description": "# Twip\r\n\r\n[](https://badge.fury.io/py/twip-api) [](https://pepy.tech/project/twip-api) [](https://pepy.tech/project/twip-api)\r\n\r\n\uc774 \ub77c\uc774\ube0c\ub7ec\ub9ac\ub294 [Twip](www.twip.kr)\uc758 \uacf5\uc2dd \ub77c\uc774\ube0c\ub7ec\ub9ac\uac00 \uc544\ub2c8\uba70, [Twip](www.twip.kr)\uc5d0\uc11c \uc2a4\ud2b8\ub9ac\uba38\ub4e4\uc5d0\uac8c \uc81c\uacf5\ud558\ub294 Alert Box\ub97c \uc774\uc6a9\ud574\uc11c \ub3c4\ub124\uc774\uc158, \ud314\ub85c\uc6b0, \ud638\uc2a4\ud305 \ub4f1\uc758 \uc774\ubca4\ud2b8\uc5d0 \ub300\ud574\uc11c \uac04\ud3b8\ud558\uac8c \ub300\uc751\ud558\uae30 \uc704\ud574\uc11c \ub9cc\ub4e4\uc5b4\uc84c\uc2b5\ub2c8\ub2e4.\r\n\r\n---\r\n\r\n## \ud83d\udce5 \uc124\uce58\r\n\r\n```shell\r\npip install twip-api\r\n```\r\n\r\n## \u270d\ufe0f Example\r\n\r\n```py\r\nfrom twip import Twip, Donate, Follow, Subscribe, Hosting, Cheer, Sound, Slotmachine\r\n\r\nclass MyTwip(Twip):\r\n def on_ready(self):\r\n print(\"Twip is ready!\")\r\n\r\n def on_donate(self, donate: Donate):\r\n print(donate)\r\n\r\n def on_follow(self, follow: Follow):\r\n print(follow)\r\n\r\n def on_subscribe(self, subscribe: Subscribe):\r\n print(subscribe)\r\n\r\n def on_hosting(self, hosting: Hosting):\r\n print(hosting)\r\n\r\n def on_cheer(self, cheer: Cheer):\r\n print(cheer)\r\n\r\n def on_sound(self, sound: Sound):\r\n print(sound)\r\n\r\nif __name__ == \"__main__\":\r\n myTwip = MyTwip()\r\n myTwip.run(\"your alert box id\", \"your twip api token\")\r\n```\r\n\r\n\ub354 \ub9ce\uc740 \uc608\uc81c\ub294 Github [example.py](https://github.com/junah201/Twip/blob/main/twip/example.py) \uc5d0\uc11c \ud655\uc778\ud558\uc138\uc694.\r\n\r\n## \ud83d\udd25 Events\r\n\r\n- **on_ready** : \ud2b8\uc715\uacfc \ucc98\uc74c\uc73c\ub85c \uc5f0\uacb0\ub418\uc5c8\uc744 \ub54c\r\n- **on_donate** : \ud6c4\uc6d0, \uc601\uc0c1\ud6c4\uc6d0, \uc2ac\ub86f\uba38\uc2e0(\ub8f0\ub81b)\r\n- **on_subscribe** : \uad6c\ub3c5\r\n- **on_hosting** : \ud638\uc2a4\ud305\r\n- **on_cheer** : \ube44\ud2b8\r\n- **on_follow** : \ud314\ub85c\uc6b0\r\n- **on_sound** : \uc18c\ub9ac\r\n\r\n## \ud83d\udcd6 Version\r\n\r\n- **[0.0.7](https://pypi.org/project/twip-api/0.0.7/)** : \uc0ac\uc6b4\ub4dc \uc774\ubca4\ud2b8\uac00 \uc5c6\uc744 \ub54c \ubc1c\uc0dd\ud558\ub358 \ubc84\uadf8 \uc218\uc815\r\n- **[0.0.8](https://pypi.org/project/twip-api/0.0.8/)** : api key\ub97c \uc9c1\uc811 \uc785\ub825 \ubc1b\ub3c4\ub85d \uc218\uc815 ([#1](https://github.com/junah201/Twip/issues/1))\r\n- **[0.0.8.1](https://pypi.org/project/twip-api/0.0.8.1/)** : \ud1a0\ud070 \ud06c\ub864\ub9c1 \uc635\uc158 \ucd94\uac00 ([#1](https://github.com/junah201/Twip/issues/1))\r\n- **[0.0.8.2](https://pypi.org/project/twip-api/0.0.8.2/)** : \ud568\uc218 \uc774\ub984 \uad00\ub828 \ubc84\uadf8 \uc218\uc815\r\n- **[0.0.9](https://pypi.org/project/twip-api/0.0.9/)** : on_ready \uc774\ubca4\ud2b8 \ucd94\uac00\r\n- **[0.0.9.1](https://pypi.org/project/twip-api/0.0.9.1/)** : \ud06c\ub864\ub9c1\ub41c \ud1a0\ud070\uc774 \uc720\ud6a8\uae30\uac04\uc774 \uc9c0\ub09c \ud6c4\uc5d0\ub3c4 \uacc4\uc18d\ud574\uc11c \uc0ac\uc6a9\ub418\ub358 \ubc84\uadf8 \uc218\uc815\r\n- **[1.0.0](https://pypi.org/project/twip-api/1.0.0/)** : \ud0c0\uc785 \ud78c\ud2b8 \ucd94\uac00 \ubc0f \uad6c\uc870 \uac1c\ud3b8\r\n\r\n## \ud83d\udd6e License\r\n\r\n- [MIT](https://github.com/junah201/Twip/blob/main/LICENSE)\r\n\r\n## \uae30\ud0c0\ubb38\uc758\r\n\r\n- Email : junah.dev@gmail.com\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Parses the things provided by twip such as donation, follow",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/junah201/Twip"
},
"split_keywords": [
"twip",
"twip.kr",
"twitch"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "29dd230d4dbd873d185c1467215e493910da6f95f26eb31656cc96c4ecc956eb",
"md5": "8247605e31e6cb23d0410a4e1d51901c",
"sha256": "20b3199b43101d219497074d97fc01e0ad4e77a670ebef0917f5686d6cf93fdc"
},
"downloads": -1,
"filename": "twip_api-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8247605e31e6cb23d0410a4e1d51901c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3",
"size": 6964,
"upload_time": "2023-07-09T19:49:43",
"upload_time_iso_8601": "2023-07-09T19:49:43.379268Z",
"url": "https://files.pythonhosted.org/packages/29/dd/230d4dbd873d185c1467215e493910da6f95f26eb31656cc96c4ecc956eb/twip_api-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-09 19:49:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "junah201",
"github_project": "Twip",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "twip-api"
}
JSON
