fix:long description

[JarbasAl]

semver automations fail if dont use full path for README

Summary by CodeRabbit

• Chores
  • Improved the file path resolution for the README.md in the package setup.

[coderabbitai]

Walkthrough

The changes involve a modification to the setup.py file of a Python package. Specifically, the path used to reference the README.md file has been updated to utilize a method that resolves the path relative to the directory of the current file. This adjustment improves the way the README file is accessed without altering any other aspects of the setup file.

Changes

File	Change Summary
setup.py	Updated the path to README.md to use path.join(path.abspath(path.dirname(__file__)), "README.md") for better path resolution.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Setup
    participant README

    User->>Setup: Initiates package setup
    Setup->>README: Accesses README.md
    README-->>Setup: Returns README content
    Setup-->>User: Completes setup with README content

Loading

Poem

🐰 In the code where paths align,
A rabbit hops, oh how divine!
With setup.py now so neat,
The README's found, a tasty treat!
Paths adjusted, all is well,
In the code, we dance and dwell! 🌟

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between c0d0f34 and 9dfc440.

📒 Files selected for processing (1)

• setup.py (1 hunks)

🧰 Additional context used

🔇 Additional comments (1)

setup.py (1)

46-46: Approved: Robust path resolution for README.md

This change improves the reliability of locating the README.md file by using an absolute path resolution method. The new approach:

1. Uses path.abspath(path.dirname(__file__)) to get the absolute path of the directory containing setup.py.
2. Joins this path with "README.md" using path.join().

This method is more robust as it will work correctly regardless of the current working directory when the script is run. It directly addresses the issue mentioned in the PR objectives about semver automations failing when not using the full path for README.

---

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
• Mastodon
• Reddit
• LinkedIn

🪧 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 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.

[codecov]

Codecov Report

Attention: Patch coverage is 0% with 1 line in your changes missing coverage. Please review.

Please upload report for BASE (dev@c0d0f34). Learn more about missing BASE report.

Files with missing lines	Patch %	Lines
setup.py	0.00%	1 Missing ⚠️

Additional details and impacted files

@@          Coverage Diff           @@
##             dev      #31   +/-   ##
======================================
  Coverage       ?   41.41%           
======================================
  Files          ?        4           
  Lines          ?      198           
  Branches       ?        0           
======================================
  Hits           ?       82           
  Misses         ?      116           
  Partials       ?        0           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.