Skip to content

Commit

Permalink
📝 Extract features and update installation
Browse files Browse the repository at this point in the history
  • Loading branch information
OpenWaygate committed Jul 28, 2024
1 parent dd82535 commit fe936f9
Show file tree
Hide file tree
Showing 2 changed files with 127 additions and 118 deletions.
132 changes: 14 additions & 118 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,18 +76,27 @@ There are two actions available for yutu, one is for general purpose and the oth
❯ docker run --rm ghcr.io/eat-pray-ai/yutu:latest
```

### Gopher

```shell
❯ go install https://github.com/eat-pray-ai/yutu@latest
```

### Linux

```shell
❯ curl -sSfL https://github.com/eat-pray-ai/yutu/releases/latest/download/yutu-linux-$(uname -m) -o yutu
❯ curl -sSfL https://github.com/eat-pray-ai/yutu/releases/latest/download/yutu-linux-$(uname -m) -o /usr/local/bin/yutu
❯ chmod +x /usr/local/bin/yutu

```

### macOS

Homebrew is not available since this repository is not notable enough, star this repository to make it available on Homebrew.

```shell
❯ curl -sSfL https://github.com/eat-pray-ai/yutu/releases/latest/download/yutu-darwin-$(uname -m) -o yutu
❯ curl -sSfL https://github.com/eat-pray-ai/yutu/releases/latest/download/yutu-darwin-$(uname -m) -o /usr/local/bin/yutu
❯ chmod +x /usr/local/bin/yutu
```

### Windows
Expand All @@ -113,6 +122,8 @@ Available Commands:
channel Manipulate YouTube channels
channelBanner Insert Youtube channelBanner
channelSection Manipulate channel section
comment Manipulate YouTube comments
commentThread Manipulate YouTube comment threads
completion Generate the autocompletion script for the specified shell
help Help about any command
i18nLanguage List YouTube i18nLanguages
Expand All @@ -138,122 +149,7 @@ Use "yutu [command] --help" for more information about a command.

## Features

Here are the features that are currently supported by yutu, and the ones that are planned to be supported in the future. The quota costs for each feature is also mentioned since there is a quota limits of 10,000 units/day.

<details>
<summary>Features list</summary>
- videos
- [x] list, 1
- [x] insert, 1600
- [x] update, 50
- [x] rate, 50
- [x] getRating, 1
- [ ] reportAbuse, 50
- [x] delete, 50
- channels
- [x] list, 1
- [x] update, 50
- playlists
- [x] list, 1
- [x] insert, 50
- [x] update, 50
- [x] delete, 50
- playlistItems
- [x] list, 1
- [x] insert, 50
- [x] update, 50
- [x] delete, 50
- playlistImages
- [ ] list, ?
- [ ] insert, ?
- [ ] upload, ?
- [ ] delete, ?
- activities
- [x] list, 1
- captions
- [x] list, 50
- [x] download, ?
- [x] insert, 400
- [x] update, 450
- [x] delete, 50
- channelBanners
- [x] insert, 50
- channelSections
- [x] list, 1
- [ ] insert, 50
- [ ] update, 50
- [x] delete, 50
- comments
- [ ] list, 1
- [ ] insert, 50
- [ ] update, 50
- [ ] setModerationStatus, 50
- [ ] delete, 50
- commentThreads
- [ ] list, 1
- [ ] insert, 50
- [ ] update, 50
- <s>guideCategories</s>
- [x] <s>list, 1 deprecated API</s>
- i18nLanguages
- [x] list, 1
- i18nRegions
- [x] list, 1
- liveBroadcasts
- [ ] list, ?
- [ ] insert, ?
- [ ] insertCuepoint, ?
- [ ] update, ?
- [ ] bind, ?
- [ ] transition, ?
- [ ] delete, ?
- liveChatBans
- [ ] insert, ?
- [ ] delete, ?
- liveChatMessages
- [ ] list, ?
- [ ] insert, ?
- [ ] delete, ?
- [ ] transition, ?
- liveChatModerators
- [ ] list, ?
- [ ] insert, ?
- [ ] delete, ?
- liveStreams
- [ ] list, ?
- [ ] insert, ?
- [ ] update, ?
- [ ] delete, ?
- members
- [x] list, 1 [🚫issue #3](https://github.com/eat-pray-ai/yutu/issues/3)
- membershipsLevels
- [x] list, 1 [🚫issue #3](https://github.com/eat-pray-ai/yutu/issues/3)
- search
- [x] list, 100
- subscriptions
- [x] list, 1
- [x] insert, 50
- [x] delete, 50
- superChatEvents
- [ ] list, ?
- tests
- [ ] insert, ?
- thirdPartyLinks
- [ ] list, ?
- [ ] insert, ?
- [ ] update, ?
- [ ] delete, ?
- thumbnails
- [x] set, 50
- videoAbuseReportReasons
- [x] list, 1
- videoCategories
- [x] list, 1
- watermarks
- [x] set, 50
- [x] unset, 50

</details>
Please refer to [features.md](./features.md) for more information.

## Star History

Expand Down
113 changes: 113 additions & 0 deletions features.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
# Features

Here are the features that are currently supported by yutu, and the ones that are planned to be supported in the future. The quota costs for each feature is also mentioned since there is a quota limits of 10,000 units/day.

- videos
- [x] list, 1
- [x] insert, 1600
- [x] update, 50
- [x] rate, 50
- [x] getRating, 1
- [x] reportAbuse, 50
- [x] delete, 50
- channels
- [x] list, 1
- [x] update, 50
- playlists
- [x] list, 1
- [x] insert, 50
- [x] update, 50
- [x] delete, 50
- playlistItems
- [x] list, 1
- [x] insert, 50
- [x] update, 50
- [x] delete, 50
- playlistImages
- [ ] list, ?
- [ ] insert, ?
- [ ] upload, ?
- [ ] delete, ?
- activities
- [x] list, 1
- captions
- [x] list, 50
- [x] download, ?
- [x] insert, 400
- [x] update, 450
- [x] delete, 50
- channelBanners
- [x] insert, 50
- channelSections
- [x] list, 1
- [ ] insert, 50
- [ ] update, 50
- [x] delete, 50
- comments
- [x] list, 1
- [x] insert, 50
- [x] update, 50
- [x] setModerationStatus, 50
- [x] delete, 50
- commentThreads
- [x] list, 1
- [x] insert, 50
- <s>guideCategories</s>
- [x] <s>list, 1 deprecated API</s>
- i18nLanguages
- [x] list, 1
- i18nRegions
- [x] list, 1
- liveBroadcasts
- [ ] list, ?
- [ ] insert, ?
- [ ] insertCuepoint, ?
- [ ] update, ?
- [ ] bind, ?
- [ ] transition, ?
- [ ] delete, ?
- liveChatBans
- [ ] insert, ?
- [ ] delete, ?
- liveChatMessages
- [ ] list, ?
- [ ] insert, ?
- [ ] delete, ?
- [ ] transition, ?
- liveChatModerators
- [ ] list, ?
- [ ] insert, ?
- [ ] delete, ?
- liveStreams
- [ ] list, ?
- [ ] insert, ?
- [ ] update, ?
- [ ] delete, ?
- members
- [x] list, 1 [🚫issue #3](https://github.com/eat-pray-ai/yutu/issues/3)
- membershipsLevels
- [x] list, 1 [🚫issue #3](https://github.com/eat-pray-ai/yutu/issues/3)
- search
- [x] list, 100
- subscriptions
- [x] list, 1
- [x] insert, 50
- [x] delete, 50
- superChatEvents
- [ ] list, ?
- tests
- [ ] insert, ?
- thirdPartyLinks
- [ ] list, ?
- [ ] insert, ?
- [ ] update, ?
- [ ] delete, ?
- thumbnails
- [x] set, 50
- videoAbuseReportReasons
- [x] list, 1
- videoCategories
- [x] list, 1
- watermarks
- [x] set, 50
- [x] unset, 50

0 comments on commit fe936f9

Please sign in to comment.