Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New recipe: gff-to-genbank (grayskull generated) #51977

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

corneliusroemer
Copy link
Member

Describe your pull request here


Please read the guidelines for Bioconda recipes before opening a pull request (PR).

General instructions

  • If this PR adds or updates a recipe, use "Add" or "Update" appropriately as the first word in its title.
  • New recipes not directly relevant to the biological sciences need to be submitted to the conda-forge channel instead of Bioconda.
  • PRs require reviews prior to being merged. Once your PR is passing tests and ready to be merged, please issue the @BiocondaBot please add label command.
  • Please post questions on Gitter or ping @bioconda/core in a comment.

Instructions for avoiding API, ABI, and CLI breakage issues

Conda is able to record and lock (a.k.a. pin) dependency versions used at build time of other recipes.
This way, one can avoid that expectations of a downstream recipe with regards to API, ABI, or CLI are violated by later changes in the recipe.
If not already present in the meta.yaml, make sure to specify run_exports (see here for the rationale and comprehensive explanation).
Add a run_exports section like this:

build:
  run_exports:
    - ...

with ... being one of:

Case run_exports statement
semantic versioning {{ pin_subpackage("myrecipe", max_pin="x") }}
semantic versioning (0.x.x) {{ pin_subpackage("myrecipe", max_pin="x.x") }}
known breakage in minor versions {{ pin_subpackage("myrecipe", max_pin="x.x") }} (in such a case, please add a note that shortly mentions your evidence for that)
known breakage in patch versions {{ pin_subpackage("myrecipe", max_pin="x.x.x") }} (in such a case, please add a note that shortly mentions your evidence for that)
calendar versioning {{ pin_subpackage("myrecipe", max_pin=None) }}

while replacing "myrecipe" with either name if a name|lower variable is defined in your recipe or with the lowercase name of the package in quotes.

Bot commands for PR management

Please use the following BiocondaBot commands:

Everyone has access to the following BiocondaBot commands, which can be given in a comment:

@BiocondaBot please update Merge the master branch into a PR.
@BiocondaBot please add label Add the please review & merge label.
@BiocondaBot please fetch artifacts Post links to CI-built packages/containers.
You can use this to test packages locally.

Note that the @BiocondaBot please merge command is now depreciated. Please just squash and merge instead.

Also, the bot watches for comments from non-members that include @bioconda/<team> and will automatically re-post them to notify the addressed <team>.

Copy link
Contributor

coderabbitai bot commented Nov 6, 2024

Warning

Rate limit exceeded

@mencian has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 14 minutes and 37 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

Reviewing files that changed from the base of the PR and between dc2cb3d and feb3aad.

📝 Walkthrough
📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request introduces a new file named meta.yaml for the gff-to-genbank project, version 0.0.3. This file outlines the package configuration, including the package name, version, source URL, and SHA256 checksum for integrity verification. It specifies the entry point for the package, indicating that the main function is located in gff_to_genbank.gff_to_genbank. The package is designated as architecture-independent and includes installation instructions using pip without dependencies or build isolation. The requirements section lists host and runtime dependencies, including Python 3.8 or higher, hatchling, pip, bcbio-gff, and biopython. The test section provides commands for installation verification, and the about section includes metadata such as a summary, development URL, home URL, license type, and license file reference. Additionally, the recipe maintainer is specified.

Possibly related PRs

  • recipe for pgrc #50973: The meta.yaml file for the pgrc package also establishes package configuration, including dependencies and source URL, similar to the changes made in the gff-to-genbank package's meta.yaml.
  • Add seqspec #51326: The seqspec package's meta.yaml similarly defines package metadata, dependencies, and source URL, paralleling the structure and purpose of the gff-to-genbank meta.yaml.
  • genbank: add aarch64/arm64 builds #51448: The genbank package's meta.yaml includes updates to the build number and source URL, which aligns with the changes made in the gff-to-genbank meta.yaml.
  • Add libgff recipe #51706: The libgff package's meta.yaml introduces a new package configuration, including dependencies and source URL, akin to the updates in the gff-to-genbank meta.yaml.
  • Rebuild libgff recipe #51746: The rebuild of the libgff recipe involves modifications to the meta.yaml, including build number updates, which is a similar type of change seen in the gff-to-genbank PR.

Suggested labels

please review & merge

Suggested reviewers

  • adamhospital
  • gbayarri
  • mencian

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

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)
recipes/gff-to-genbank/meta.yaml (1)

31-38: Consider adding functional tests with sample data.

While basic import and CLI tests are present, adding functional tests with sample GFF files would provide better validation of the package's core functionality.

Example addition:

  commands:
    - pip check
    - gff-to-genbank --help
+   - gff-to-genbank --test-data ${RECIPE_DIR}/test.gff --output test.gb  # [not win]
  requires:
    - pip
+  files:
+    - test.gff
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 27fa1b9 and 652a50c.

📒 Files selected for processing (1)
  • recipes/gff-to-genbank/meta.yaml (1 hunks)
🧰 Additional context used
🪛 yamllint
recipes/gff-to-genbank/meta.yaml

[error] 1-1: syntax error: found character '%' that cannot start any token

(syntax)

🔇 Additional comments (5)
recipes/gff-to-genbank/meta.yaml (5)

1-6: LGTM! Package metadata follows Conda-forge best practices.

🧰 Tools
🪛 yamllint

[error] 1-1: syntax error: found character '%' that cannot start any token

(syntax)


8-10: LGTM! Source configuration is properly defined with integrity check.


21-29: LGTM! Dependencies are well-defined with appropriate version constraints.


40-45: LGTM! Package metadata is complete with all required fields.


47-49: LGTM! Maintainer information is correctly specified.

Comment on lines 18 to 19
run_exports:
- {{ pin_subpackage("myrecipe", max_pin="x.x") }}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Remove incorrect run_exports configuration.

The run_exports section references a non-existent package myrecipe. This appears to be copied from a template and should be removed as it's not applicable for this Python package.

-  run_exports:
-    - {{ pin_subpackage("myrecipe", max_pin="x.x") }}
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
run_exports:
- {{ pin_subpackage("myrecipe", max_pin="x.x") }}

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)
recipes/gff-to-genbank/meta.yaml (1)

31-38: Consider enhancing test coverage.

While basic tests are present, consider adding a test with a sample GFF file to verify actual conversion functionality.

Would you like me to help create additional test commands with sample data?

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 652a50c and dc2cb3d.

📒 Files selected for processing (1)
  • recipes/gff-to-genbank/meta.yaml (1 hunks)
🧰 Additional context used
🪛 yamllint
recipes/gff-to-genbank/meta.yaml

[error] 1-1: syntax error: found character '%' that cannot start any token

(syntax)

🔇 Additional comments (5)
recipes/gff-to-genbank/meta.yaml (5)

8-10: LGTM!

Source URL and checksum are properly configured following PyPI package conventions.


21-29: LGTM!

Dependencies and their version constraints are appropriately specified for both build and runtime environments.


40-45: LGTM!

Package metadata is complete with appropriate description, URLs, and license information.


47-49: LGTM!

Maintainer information is correctly specified.


18-19: ⚠️ Potential issue

Remove unnecessary run_exports configuration.

The run_exports section is typically not needed for Python packages, especially noarch ones. This should be removed to follow Bioconda's best practices.

-  run_exports:
-    - {{ pin_subpackage("gff-to-genbank", max_pin="x.x") }}

Comment on lines 1 to 6
{% set name = "gff-to-genbank" %}
{% set version = "0.0.3" %}

package:
name: {{ name|lower }}
version: {{ version }}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codebase verification

Package version needs to be updated to 0.1.0

The recipe currently uses version 0.0.3, but version 0.1.0 is available on PyPI. Please update the version in meta.yaml to match the latest release.

🔗 Analysis chain

Verify package version.

The package version is set to 0.0.3, which appears to be an early development version. Please verify this is the latest version available on PyPI.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the latest version on PyPI
curl -s https://pypi.org/pypi/gff-to-genbank/json | jq -r '.info.version'

Length of output: 79

🧰 Tools
🪛 yamllint

[error] 1-1: syntax error: found character '%' that cannot start any token

(syntax)

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.

3 participants