Remove HISTORY.rst from pypi release page

[glensc]

It's no longer updated, so don't bother adding it to the description:

• https://pypi.org/project/pytrakt/4.0.2/

[coderabbitai]

Walkthrough

The pull request modifies the setup.py file, specifically altering how the long description for the package is generated. The change simplifies the long description by removing the historical context from the HISTORY.rst file and now only using the content from README.rst. This modification streamlines the package metadata generation process by reducing the complexity of how the long description is constructed.

Changes

File	Change Summary
setup.py	Removed reading of HISTORY.rst file and simplified long_description to only use README.rst content

Poem

🐰 A Setup Bunny's Ballad

Metadata trimmed, history set aside,
README now takes the spotlight with pride
Simplicity hops through the package's core
Less complexity than ever before
A cleaner setup, neat and bright! 🚀

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1fb43d3 and 060300a.

📒 Files selected for processing (1)

• setup.py (1 hunks)

🔇 Additional comments (1)

setup.py (1)

20-20: LGTM! The change aligns with PR objectives.

The simplified long_description parameter correctly removes the outdated HISTORY.rst content while maintaining the package description from README.rst.

Let's verify that the PyPI page will display correctly with just the README content:

✅ Verification successful

README.rst validation successful - PyPI description will render correctly

The file contains valid RST syntax with proper headers, directives, and badges. The simplified long_description using only README content is safe to use.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify README.rst exists and is properly formatted
# This helps ensure the PyPI page will render correctly

# Check if README.rst exists and is not empty
if [ ! -s "README.rst" ]; then
    echo "ERROR: README.rst is missing or empty"
    exit 1
fi

# Basic RST syntax validation using pip
pip install docutils
python -m docutils.parsers.rst.rst2html README.rst /dev/null

echo "README.rst validation complete"

Length of output: 884

---

Script:

#!/bin/bash
# Check README.rst content and structure
echo "=== First 10 lines of README.rst ==="
head -n 10 README.rst

echo -e "\n=== Checking for RST syntax patterns ==="
# Look for common RST patterns like headers, directives, etc.
grep -E "^[=\-~]{3,}$|^\.\. |^:.*:$" README.rst

echo -e "\n=== File info ==="
file README.rst

Length of output: 1026

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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 generate docstrings to generate docstrings for this PR. (Beta)
• @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.