fix:long description

[JarbasAl]

needs absolute path to readme file

fixes automation failures when reading version from setup.py to get tag name

Summary by CodeRabbit

• Chores
  • Improved the reliability of README file access by using an absolute path, ensuring consistent behavior across different environments.

[coderabbitai]

Warning

Rate limit exceeded

@github-actions[bot] has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 26 minutes and 58 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 6237851 and 38a3387.

Walkthrough

The changes involve modifying the setup.py file to improve the method of accessing the README.md file. The previous implementation utilized a relative path, while the updated version constructs the path using a BASEDIR variable. This adjustment ensures that the script can accurately locate the README.md file, regardless of the current working directory.

Changes

File	Change Summary
setup.py	Updated the method of accessing README.md by using a BASEDIR variable instead of a direct relative path.

Sequence Diagram(s)

sequenceDiagram
    participant Script
    participant FileSystem
    participant README

    Script->>FileSystem: Request README.md
    FileSystem->>Script: Provide path using BASEDIR
    Script->>README: Open README.md
    README-->>Script: Return content

Loading

Poem

In the code where rabbits play,
A path was lost along the way.
With BASEDIR now in sight,
The README shines so bright!
Hops of joy, we leap and bound,
For clearer paths, our code is sound! 🐇✨

---

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

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 43.88%. Comparing base (4548352) to head (38a3387).
Report is 14 commits behind head on dev.

Additional details and impacted files

@@            Coverage Diff             @@
##              dev     #268      +/-   ##
==========================================
- Coverage   53.80%   43.88%   -9.93%     
==========================================
  Files          60       31      -29     
  Lines        3942     3245     -697     
==========================================
- Hits         2121     1424     -697     
  Misses       1821     1821              

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