transfermarkt-api icon indicating copy to clipboard operation
transfermarkt-api copied to clipboard

Add endpoint to get all players' names

Open olllayor opened this issue 10 months ago • 1 comments

Add endpoint to fetch all players' names.

  • Add a new endpoint get_all_players_names in app/api/endpoints/players.py.
  • Create a new method get_all_players_names in app/services/players/search.py to fetch all players' names.
  • Update the PlayerSearch schema in app/schemas/players/search.py to include only the name field.
  • Add a new test case in tests/players/test_players_search.py to test the get_all_players_names method.
  • Add main.py file with a simple print statement.
  • Update pyproject.toml to reflect the new project structure and dependencies.
  • Add uv.lock file with the project dependencies.

For more details, open the Copilot Workspace session.

Summary by CodeRabbit

  • New Features

    • Introduced an API endpoint to retrieve a comprehensive list of player names.
    • Added a startup message that greets users when the application is launched.
  • Refactor

    • Simplified the player search output to focus solely on player names.
    • Updated project configuration to align with modern dependency standards.
  • Tests

    • Added a test case to verify the functionality of retrieving player names.

olllayor avatar Mar 14 '25 12:03 olllayor

Walkthrough

This update adds a new API endpoint that returns a list of player names. It introduces a new function in the players endpoint that leverages an additional method in the player search service to retrieve names. The player search schema is simplified by removing several classes and attributes. A basic main entry point is added for startup, and project metadata is restructured in the configuration file. A new test case verifies that the player names are correctly retrieved.

Changes

File(s) Change Summary
app/api/endpoints/players.py, app/services/players/search.py,
tests/players/test_players_search.py
Added a new GET endpoint /all_players_names, including a service method to fetch player names and a test to ensure it returns a non-empty list of strings.
app/schemas/players/search.py Simplified the PlayerSearch schema by removing the PlayerSearchClub and PlayerSearchResult classes and eliminating extra attributes, reducing the schema to a single name field.
main.py Introduced a new main() function that prints a greeting when the module is run as the main program.
pyproject.toml Refactored project configuration by replacing the Poetry-specific format with a generic [project] descriptor, downgrading the version, updating the description, modifying the Python requirement, and redefining dependencies.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API
    participant PlayerSearchService
    participant DataFetcher

    Client->>API: GET /all_players_names
    API->>PlayerSearchService: get_all_players_names()
    PlayerSearchService->>DataFetcher: search_players()
    DataFetcher-->>PlayerSearchService: search results
    PlayerSearchService-->>API: list of player names
    API-->>Client: JSON response with player names

Poem

I’m a rabbit with a joyful hop,
Leaping through code with a non-stop bop,
New endpoints bloom like springtime treats,
Schemas now lean with cleaner beats,
Tests confirm our code’s on track,
Hop along, dear devs, and never look back! 🥕🐇

[!TIP]

⚡🧪 Multi-step agentic review comment chat (experimental)
  • We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments. - To enable this feature, set early_access to true under in the settings.
✨ Finishing Touches
  • [ ] 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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 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 generate docstrings to generate docstrings for this 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.

coderabbitai[bot] avatar Mar 14 '25 12:03 coderabbitai[bot]