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

Add meta_eukaryome_detect #51328

Merged
merged 7 commits into from
Oct 13, 2024
Merged

Add meta_eukaryome_detect #51328

merged 7 commits into from
Oct 13, 2024

Conversation

fullama
Copy link
Contributor

@fullama fullama commented Oct 11, 2024

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 Oct 11, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request updates the meta.yml file for the meta_eukaryome_detect package to version 0.1.1. Key changes include an updated package source URL reflecting the new version and the addition of a SHA256 checksum for integrity verification. The entry point remains unchanged, directing to the main function in the meta_eukaryome_detect.meta_eukaryome_detect module. The build configuration specifies a pip installation script and indicates that the package is architecture-independent (noarch).

The requirements section has been modified to include new dependencies such as ngless, samtools, pandas (version 2.0 or higher), and requests, categorized under host and run. The test section now includes a command to display the help message for meta-eukaryome-detect. Additional metadata has been added, including the homepage, license (MIT License), a summary of the package's functionality, and links to documentation and development resources. The recipe maintainer is identified as "fullama".

Possibly related PRs

  • recipe for pgrc #50973: The meta.yaml file for the pgrc package introduces a structured configuration similar to the changes made in the meta.yml for meta_eukaryome_detect.
  • Update panacus recipe to add cmake and c++ dependency #50982: The update to the panacus recipe includes modifications to the meta.yaml file, particularly in the build requirements, which aligns with the structured configuration changes in the meta.yml for meta_eukaryome_detect.
  • Add Snk #51152: The addition of the snk package involves a new meta.yaml file that outlines dependencies and build instructions, paralleling the structured configuration updates in the meta.yml for meta_eukaryome_detect.

Suggested labels

please review & merge


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/meta_eukaryome_detect/meta.yml (1)

47-47: Remove extra blank line at the end of the file.

To improve file consistency and adhere to YAML best practices, please remove the extra blank line at the end of the file.

Apply this change:

 extra:
   recipe-maintainers:
     - fullama

-
🧰 Tools
🪛 yamllint

[warning] 47-47: too many blank lines

(1 > 0) (empty-lines)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 74bb24f and 2755140.

📒 Files selected for processing (1)
  • recipes/meta_eukaryome_detect/meta.yml (1 hunks)
🧰 Additional context used
🪛 yamllint
recipes/meta_eukaryome_detect/meta.yml

[warning] 47-47: too many blank lines

(1 > 0) (empty-lines)


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

(syntax)

🔇 Additional comments (5)
recipes/meta_eukaryome_detect/meta.yml (5)

1-10: LGTM! Package and source sections are well-defined.

The package name and version are correctly set using Jinja2 variables, which is a good practice for maintainability. The source URL is properly constructed using these variables, following the standard PyPI format. The inclusion of a SHA256 checksum is crucial for verifying the integrity of the downloaded package.

Note: The syntax error reported by yamllint for the '%' character is a false positive. This is valid Jinja2 syntax in YAML and is commonly used in Conda recipes.

🧰 Tools
🪛 yamllint

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

(syntax)


35-42: LGTM! About section is comprehensive and well-documented.

The about section provides all necessary metadata:

  • Home URL is correctly specified.
  • License information is clear (MIT License).
  • A concise summary describes the package's functionality.
  • Documentation and development URLs are provided.

This information is crucial for users to understand the package's purpose and find additional resources.


44-46: LGTM! Maintainer information is correctly specified.

The extra section correctly lists the recipe maintainer as "fullama". This information is crucial for package management and future updates.


19-27: Verify run requirements and consider pandas version constraint.

The host requirements look appropriate for building the package. However, for the run requirements:

  1. Please verify that all listed dependencies (ngless, samtools, pandas, requests) are necessary for the package's functionality.
  2. Consider if version constraints are needed for ngless, samtools, and requests.
  3. The pandas version constraint (>= 2.0) is quite recent. Consider if this strict requirement is necessary, as it might limit compatibility with other packages or older systems.

To help verify the dependencies, please run:

#!/bin/bash
# Description: Search for import statements and usage of required packages

# Test: Search for import statements and usage of required packages
rg --type python 'import (ngless|samtools|pandas|requests)' -A 3
rg --type python '(ngless|samtools|pandas|requests)\.' -A 3

This will help confirm the usage of these packages in the code and potentially identify any version-specific features being used.


12-17: LGTM! Build section is well-configured.

The build configuration looks good:

  • Build number is correctly set to 0 for a new package.
  • The installation script using pip is appropriate.
  • Marking the package as noarch: python is correct if it's compatible with all Python versions and platforms.

However, it's important to verify the correctness of the entry point:

Please run the following script to verify the entry point:

This will help ensure that the entry point meta-eukaryome-detect = meta_eukaryome_detect.meta_eukaryome_detect:main is correctly defined in the package's configuration.

recipes/meta_eukaryome_detect/meta.yml Outdated Show resolved Hide resolved
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 (3)
recipes/meta_eukaryome_detect/meta.yml (3)

15-15: Consider using underscores in the entry point name.

The entry point name currently uses hyphens (meta-eukaryome-detect). It's generally recommended to use underscores in Python package names and entry points for better compatibility. Consider changing it to meta_eukaryome_detect.

Here's the suggested change:

-    - meta-eukaryome-detect = meta_eukaryome_detect.meta_eukaryome_detect:main
+    - meta_eukaryome_detect = meta_eukaryome_detect.meta_eukaryome_detect:main

20-20: Remove trailing spaces.

There are trailing spaces on this line. Please remove them to adhere to YAML best practices and resolve the linting error.

Here's the suggested change:

-    
+
🧰 Tools
🪛 yamllint

[error] 20-20: trailing spaces

(trailing-spaces)


28-28: Fix pandas version requirement.

The pandas version requirement has a trailing dot, which should be removed for consistency and to avoid potential issues.

Here's the suggested change:

-    - pandas >= 2.0.
+    - pandas >= 2.0
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 2755140 and 2ec362f.

📒 Files selected for processing (1)
  • recipes/meta_eukaryome_detect/meta.yml (1 hunks)
🧰 Additional context used
🪛 yamllint
recipes/meta_eukaryome_detect/meta.yml

[error] 20-20: trailing spaces

(trailing-spaces)


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

(syntax)

🔇 Additional comments (4)
recipes/meta_eukaryome_detect/meta.yml (4)

1-6: LGTM: Package name and version are correctly defined.

The package name and version are properly set using Jinja2 templating, which is the recommended approach for Bioconda recipes.

🧰 Tools
🪛 yamllint

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

(syntax)


8-10: LGTM: Source URL and checksum are correctly specified.

The source URL is properly constructed using Jinja2 templating, and the SHA256 checksum is provided for package integrity verification.


37-44: LGTM: About section is complete and well-formatted.

The about section provides all necessary metadata, including home URL, license information, summary, and documentation links. This follows Bioconda guidelines and best practices.


46-48: LGTM: Recipe maintainer is correctly specified.

The extra section properly lists the recipe maintainer, which is important for package maintenance and communication.

recipes/meta_eukaryome_detect/meta.yml Show resolved Hide resolved
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 (2)
recipes/meta_eukaryome_detect/meta.yml (2)

12-20: LGTM: Build configuration looks good, with a minor formatting issue.

The build configuration is correct, including the noarch specification and the addition of the run_exports section for version pinning. However, there's a minor formatting issue to address:

Please remove the trailing space on line 20:

  run_exports:
    {{ pin_subpackage(name, max_pin="x") }}
-    
+
🧰 Tools
🪛 yamllint

[error] 20-20: trailing spaces

(trailing-spaces)


31-35: Good improvements, consider adding a version check.

The test section has been improved by addressing the inconsistency in naming (using underscores consistently). However, as suggested in previous reviews, it would be beneficial to add a version check for more comprehensive testing.

Consider adding a version check to the test commands:

 test:
   imports:
     - meta_eukaryome_detect
   commands:
     - meta_eukaryome_detect --help
+    - meta_eukaryome_detect --version

This addition will help ensure that the package is correctly installed and can report its version.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 2ec362f and ac54235.

📒 Files selected for processing (1)
  • recipes/meta_eukaryome_detect/meta.yml (1 hunks)
🧰 Additional context used
🪛 yamllint
recipes/meta_eukaryome_detect/meta.yml

[error] 20-20: trailing spaces

(trailing-spaces)


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

(syntax)

🔇 Additional comments (4)
recipes/meta_eukaryome_detect/meta.yml (4)

1-10: LGTM: Package metadata and source information updated correctly.

The package version has been updated to 0.1.1, and the source URL reflects this change. The SHA256 checksum is provided for the new version, which is good practice for ensuring package integrity.

🧰 Tools
🪛 yamllint

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

(syntax)


37-44: LGTM: Comprehensive metadata provided.

The about section is well-documented, providing all necessary metadata including the home page, license information, summary, and relevant URLs. The addition of the license family and license file is particularly good for compliance purposes.


46-48: LGTM: Recipe maintainer correctly specified.

The extra section properly identifies the recipe maintainer.


1-1: Note on yamllint error: Can be safely ignored.

The yamllint tool reports a syntax error for the '%' character at the beginning of the file. This is a false positive as the '%' is part of the Jinja2 template syntax, which is valid and commonly used in Conda recipe YAML files. No action is required to address this error.

🧰 Tools
🪛 yamllint

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

(syntax)

recipes/meta_eukaryome_detect/meta.yml Outdated Show resolved Hide resolved
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
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: 0

🧹 Outside diff range and nitpick comments (2)
recipes/meta_eukaryome_detect/meta.yml (2)

12-20: LGTM: Build configuration is well-defined, with a minor formatting issue.

The build section is correctly configured with the appropriate entry point, build script, and noarch specification. The inclusion of the run_exports section is a good practice for version pinning.

However, there's a minor formatting issue:

Remove the trailing space on line 20:

  run_exports:
    {{ pin_subpackage(name, max_pin="x") }}
-    
+
🧰 Tools
🪛 yamllint

[error] 20-20: trailing spaces

(trailing-spaces)


30-34: Improve test coverage: Add a version check.

The test section looks good, with consistent use of underscores in both the import check and the command. However, to improve test coverage:

Consider adding a version check as suggested in a previous review:

 test:
   imports:
     - meta_eukaryome_detect
   commands:
     - meta_eukaryome_detect --help
+    - meta_eukaryome_detect --version

This addition will help ensure that the package is correctly installed and can report its version.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between ac54235 and b6cb4a1.

📒 Files selected for processing (1)
  • recipes/meta_eukaryome_detect/meta.yml (1 hunks)
🧰 Additional context used
🪛 yamllint
recipes/meta_eukaryome_detect/meta.yml

[error] 20-20: trailing spaces

(trailing-spaces)


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

(syntax)

🔇 Additional comments (5)
recipes/meta_eukaryome_detect/meta.yml (5)

1-10: LGTM: Package and source information are correctly defined.

The package name, version, source URL, and SHA256 checksum are all properly specified. The version has been updated to 0.1.1, which matches the information in the PR summary.

🧰 Tools
🪛 yamllint

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

(syntax)


21-29: LGTM: Requirements are well-defined and appropriate.

The host and run requirements are correctly specified. The pandas version has been properly updated to >= 2.0 as suggested in a previous review. The Python version requirement of >=3.11 is suitable for a modern package.


36-43: LGTM: About section is comprehensive and well-documented.

The about section provides all necessary metadata, including the home page, license information (with family and file), a concise summary, and relevant URLs for documentation and development. This information is valuable for users and maintainers of the package.


45-47: LGTM: Recipe maintainer is correctly specified.

The extra section properly identifies "fullama" as the recipe maintainer.


1-1: Note: Ignore yamllint syntax error for Jinja2 template.

The yamllint tool reports a syntax error for the '%' character at the beginning of the file. This is a false positive, as the '%' is part of the Jinja2 template syntax, which is valid and commonly used in Conda recipe YAML files. No action is required to address this warning.

🧰 Tools
🪛 yamllint

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

(syntax)

@fullama
Copy link
Contributor Author

fullama commented Oct 11, 2024

@BiocondaBot please add label

@BiocondaBot BiocondaBot added the please review & merge set to ask for merge label Oct 11, 2024
@martin-g martin-g merged commit b8fe8b8 into bioconda:master Oct 13, 2024
7 checks passed
This was referenced Oct 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
please review & merge set to ask for merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants