Skip to content

feat: update typeline and support Python 3.13#32

Merged
clintval merged 2 commits intomainfrom
cv_update_typeline
Apr 23, 2025
Merged

feat: update typeline and support Python 3.13#32
clintval merged 2 commits intomainfrom
cv_update_typeline

Conversation

@clintval
Copy link
Owner

@clintval clintval commented Apr 23, 2025

Summary by CodeRabbit

  • New Features
    • Added support and documentation for Python 3.13.
  • Chores
    • Updated project configuration to the standardized format and reorganized metadata, dependencies, and tool settings.
    • Improved and clarified development workflow by updating continuous integration and build processes.
  • Documentation
    • Updated badges and removed obsolete instructions for task runner plugins.

@coderabbitai
Copy link

coderabbitai bot commented Apr 23, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

This update introduces several changes across the project. The continuous integration workflows are updated to use Poetry 2.1.1 via the snok/install-poetry GitHub Action, and Python 3.13 is added to the test and build matrices. Documentation is revised to reflect these changes, including removal of manual plugin installation instructions and an updated Python version badge. The pyproject.toml file is migrated to the PEP 621 [project] format with updated metadata, dependencies, and tool configurations. Additionally, the BedReader and BedWriter classes are updated to inherit from TsvReader and TsvWriter respectively.

Changes

File(s) Change Summary
.github/workflows/publish_bedspec.yml,
.github/workflows/tests.yml
Updated Poetry installation to use snok/install-poetry@v1 GitHub Action with Poetry 2.1.1; removed manual installation steps; expanded Python matrix in tests to include 3.13; removed poethepoet installation in tests.
.github/workflows/wheels.yml Added Python 3.13 to the build matrix for wheel building.
CONTRIBUTING.md Removed instructions for manual installation of the poethepoet plugin and references to Poetry v2.0.0 plugin support.
README.md Updated the supported Python versions badge to include Python 3.13.
bedspec/_reader.py Changed import and base class for BedReader from TsvRecordReader to TsvReader.
bedspec/_writer.py Changed import and base class for BedWriter from TsvRecordWriter to TsvWriter.
pyproject.toml Migrated to [project] table format; updated metadata, dependencies, and URLs; reorganized dev dependencies; updated tool configurations for poe, mypy, pyright, and ruff; adjusted task runner flags and linting rules; set new project version (0.7.0).

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant GitHub Actions
    participant Poetry Installer
    participant Test Runner

    Developer->>GitHub Actions: Push code / PR
    GitHub Actions->>Poetry Installer: Install Poetry 2.1.1 via snok/install-poetry@v1
    GitHub Actions->>GitHub Actions: Set up Python (3.10, 3.11, 3.12, 3.13)
    GitHub Actions->>GitHub Actions: Install dependencies
    GitHub Actions->>Test Runner: Run tests/build wheels
    Test Runner-->>GitHub Actions: Report results
    GitHub Actions-->>Developer: Display CI status
Loading

Possibly related PRs

  • clintval/bedspec#27: Changes the base classes for BedReader and BedWriter from TsvStructReader/Writer to TsvRecordReader/Writer, indicating both PRs update the same classes but with different base classes and method adjustments.

Poem

In the garden of code, a new path is paved,
Poetry blooms, and old plugins are waived.
Python 3.13 joins the warren’s delight,
Readers and writers hop to new heights.
Docs are refreshed, the badge shines anew—
A rabbit’s proud leap, for the whole coding crew!
🐇✨


📜 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 32fa692 and 4e62f9d.

⛔ Files ignored due to path filters (1)
  • poetry.lock is excluded by !**/*.lock
📒 Files selected for processing (8)
  • .github/workflows/publish_bedspec.yml (2 hunks)
  • .github/workflows/tests.yml (2 hunks)
  • .github/workflows/wheels.yml (1 hunks)
  • CONTRIBUTING.md (0 hunks)
  • README.md (1 hunks)
  • bedspec/_reader.py (2 hunks)
  • bedspec/_writer.py (1 hunks)
  • pyproject.toml (8 hunks)
✨ 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 generate sequence diagram to generate a sequence diagram of the changes in 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.

@clintval clintval merged commit 185a628 into main Apr 23, 2025
8 of 9 checks passed
@clintval clintval deleted the cv_update_typeline branch April 23, 2025 01:14
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