search

INCT-DD / tiktok-sdk

Async wrapper for the TikTok research API
https://inct-dd.github.io/tiktok-sdk/
GNU Affero General Public License v3.0
1 stars 0 forks source link

feat!: implement video queries #21

Closed alexandreteles closed 1 month ago

alexandreteles commented 1 month ago

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough ## Walkthrough The pull request introduces substantial enhancements to the TikTok library, particularly aimed at improving video query functionalities. Key additions include the `VideoQueryRequestBuilder` class, which facilitates the construction of video queries through various methods and models. The `APIEndpoints` class has been expanded to include new endpoint URLs, and modifications have been made to existing classes to enhance data handling and structure. These updates collectively aim to streamline the retrieval of video-related data from the TikTok API. ## Changes | File Path | Change Summary | |-----------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `README.md` | Enhanced description of the TikTok library, added section on `VideoQueryRequestBuilder`, provided example code for building video queries, and included a link to TikTok Research API documentation. | | `TikTok/Queries/Common.py` | Modified `_fetch_data` function to include `by_alias=True` in `model_dump` method and added logging for API response text. | | `TikTok/Queries/Video.py` | Introduced `VideoQueries` class with an asynchronous `search` method for video-related API queries. | | `TikTok/Query.py` | Added `video` attribute to `Query` class, initializing it with an instance of `VideoQueries`. | | `TikTok/ValidationModels/RestAPI.py` | Updated `APIEndpoints` class to include new attributes for various TikTok API endpoints, enhancing structured access to URLs. | | `TikTok/ValidationModels/User.py` | Changed inheritance of `UserInfoResponseDataModel` from `BaseRequestModel` to `BaseModel`. | | `TikTok/ValidationModels/Video.py` | Introduced multiple classes and enums for validating and constructing video queries, including `VideoQueryRequestModel`, `Condition`, and `VideoDataModel`. | | `TikTok/ValidationModels/VideoHelper.py`| Added `VideoRegionCode` enumeration for standardized representation of TikTok video region codes. | | `TikTok/__init__.py` | Added helper class for building video queries, demonstrating how to construct and execute video queries with parameters. | ## Possibly related PRs - **#15**: The changes in the `README.md` file regarding the introduction of the `VideoQueryRequestBuilder` class and its methods are related to the modifications in the `UserQueries` class, specifically the `liked_videos` method, which also deals with video-related queries. - **#18**: The addition of the `pinned_videos` method in the `UserQueries` class is relevant as it expands the functionality for querying videos, similar to the enhancements made in the main PR with the `VideoQueryRequestBuilder` class and its associated methods. > In the realm of TikTok's code, > New queries and helpers unfold, > With videos now easy to find, > A structured path for every mind. > From users to likes, all in view, > A dance of data, fresh and new! 🎶

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: -- `I pushed a fix in commit , please review it.` -- `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: -- `@coderabbitai generate unit testing code for this file.` -- `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: -- `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` -- `@coderabbitai read src/utils.ts and generate unit testing code.` -- `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` -- `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.