Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: implement query for liked videos #15

Merged
merged 6 commits into from
Sep 16, 2024
Merged

Conversation

alexandreteles
Copy link
Member

@alexandreteles alexandreteles commented Sep 16, 2024

Summary by CodeRabbit

Release Notes

  • New Features

    • Enhanced user information retrieval from the TikTok API, now including follower count, following count, video count, and likes count.
    • Added new API endpoint for fetching a user's liked videos.
  • Improvements

    • Restructured query classes for better organization and modularity.
    • Introduced dedicated exception handling for improved error management.
  • Documentation

    • Updated README and module-level documentation for clarity on new functionalities and structures.
  • Chores

    • Updated setuptools dependency to version 75.0.0 for potential enhancements.

@alexandreteles alexandreteles self-assigned this Sep 16, 2024
Copy link

coderabbitai bot commented Sep 16, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

Walkthrough

The changes involve updates to the TikTok API client, including the restructuring of modules, the introduction of new classes for user and playlist queries, and modifications to existing import paths. The .gitignore file has been updated to exclude user-specific settings from version control. Additionally, the README.md has been revised to reflect changes in user information retrieval functionality, while the pyproject.toml file has updated the setuptools dependency version.

Changes

File Path Change Summary
.gitignore Added .vscode/ to ignore user-specific settings.
README.md Updated import statement for user info queries and modified user information retrieval method.
TikTok/Auth.py Changed import sources from TikTok.Types to TikTok.ValidationModels.
TikTok/Exceptions/__init__.py Introduced a module for managing exceptions related to the TikTok library.
TikTok/Queries/Common.py Added QueryClass for managing common API queries.
TikTok/Queries/Playlist.py Introduced PlaylistQueries class for playlist-related API interactions.
TikTok/Queries/User.py Introduced UserQueries class for user-related API interactions.
TikTok/Queries/__init__.py Established a namespace for query classes.
TikTok/Query.py Restructured Query class to serve as a façade for user and playlist queries.
TikTok/Types/User.py Removed file defining user-related models and enumerations.
TikTok/ValidationModels/Common.py Changed import path for NoExtraFieldsBaseModel.
TikTok/ValidationModels/OAuth2.py Changed import paths for NoExtraFieldsBaseModel and HeadersModel.
TikTok/ValidationModels/Playlist.py Changed import paths for validation models.
TikTok/ValidationModels/RestAPI.py Updated documentation and added UserLikedVideosURL endpoint.
TikTok/ValidationModels/User.py Introduced models and enumerations for user data handling.
TikTok/ValidationModels/__init__.py Established a namespace for validation models.
pyproject.toml Updated setuptools version from 74.1.2 to 75.0.0.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant API
    participant QueryClass
    participant UserQueries
    participant PlaylistQueries

    User->>QueryClass: Request user data
    QueryClass->>UserQueries: Forward request
    UserQueries->>API: Fetch user info
    API-->>UserQueries: Return user data
    UserQueries-->>QueryClass: Send data back
    QueryClass-->>User: Provide user data
Loading
sequenceDiagram
    participant User
    participant API
    participant QueryClass
    participant PlaylistQueries

    User->>QueryClass: Request playlist data
    QueryClass->>PlaylistQueries: Forward request
    PlaylistQueries->>API: Fetch playlist info
    API-->>PlaylistQueries: Return playlist data
    PlaylistQueries-->>QueryClass: Send data back
    QueryClass-->>User: Provide playlist data
Loading

Poem

In the land of code where changes flow,
New queries sprout, and imports grow.
User data dances, playlists sing,
A cleaner repo, oh what joy they bring!
With every update, the API shines bright,
A harmonious blend, a coder's delight! 🌟


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
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    -- I pushed a fix in commit <commit_id>, 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 generate interesting stats about this repository and render them as a table.
    -- @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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
@alexandreteles alexandreteles merged commit 17e726e into main Sep 16, 2024
1 of 3 checks passed
@alexandreteles alexandreteles deleted the feat/user-liked-videos branch September 23, 2024 00:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant