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

Adding msa4u #51864

Merged
merged 6 commits into from
Nov 3, 2024
Merged

Adding msa4u #51864

merged 6 commits into from
Nov 3, 2024

Conversation

druvus
Copy link
Member

@druvus druvus commented Nov 1, 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 Nov 1, 2024

Warning

Rate limit exceeded

@druvus has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 12 minutes and 0 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 9c2eba5 and 8684b16.

📝 Walkthrough
📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request introduces a new file named meta.yaml for the msa4u package, version 0.4.0. This file outlines the package's configuration, including its name, version, and source URL for downloading from PyPI, accompanied by a SHA256 checksum for integrity verification. The build section specifies export dependencies and includes a script for installation using pip without dependencies or build isolation. The requirements section details necessary host and runtime dependencies, which encompass Python, pip, and several libraries such as Biopython, pandas, and reportlab. The test section includes import checks and a command to verify the package's help output. Additionally, the about section provides metadata such as the project's homepage, a brief summary, and licensing information.

Possibly related PRs

Suggested labels

please review & merge, new version


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.

@druvus
Copy link
Member Author

druvus commented Nov 3, 2024

@BiocondaBot please update

@BiocondaBot
Copy link
Collaborator

I encountered an error updating your PR branch. You can report this to bioconda/core if you'd like.
-The Bot

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: 2

🧹 Outside diff range and nitpick comments (1)
recipes/msa4u/meta.yaml (1)

29-33: Consider adding more comprehensive tests.

While the current tests check basic functionality, consider adding more test commands to verify key features.

Consider adding these additional tests:

  commands:
    - msa4u --help
+    - msa4u --version
+    - python -c "import msa4u; assert msa4u.__version__ == '0.4.0'"
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 373d548 and 80a9337.

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

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

(syntax)

🔇 Additional comments (4)
recipes/msa4u/meta.yaml (4)

1-6: LGTM! Package metadata follows conda-forge standards.

🧰 Tools
🪛 yamllint

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

(syntax)


1-39: Overall recipe structure is good with minor improvements needed.

The recipe follows conda-forge standards and is appropriate for Bioconda as it's a bioinformatics tool. The suggested improvements (dependency constraints, additional tests, license consideration) will enhance reliability and maintainability, but the current implementation is functional.

🧰 Tools
🪛 yamllint

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

(syntax)


12-17: Consider adjusting the run_exports pin.

The current pin x.x might be too strict for a pure Python package. Unless this package has C extensions or strict version requirements, consider using x.x.x instead.

Consider updating the pin:

-    - {{ pin_subpackage("msa4u", max_pin="x.x") }}
+    - {{ pin_subpackage("msa4u", max_pin="x.x.x") }}

8-10: Verify package availability and checksum.

The source configuration looks correct, but let's verify the package existence and integrity.

recipes/msa4u/meta.yaml Show resolved Hide resolved
Comment on lines 35 to 39
about:
home: https://art-egorov.github.io/msa4u/
summary: "A simple visualisation tool for Multiple Sequence Alignment."
license: WTFPL
license_file: LICENSE
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

Consider using a more appropriate license for scientific software

The verification confirms that the package indeed uses the WTFPL license. For scientific software that may be used in academic or research contexts, this license choice raises concerns:

  • Lacks explicit terms for attribution and citation requirements
  • No clear statements about warranties and liability
  • May not meet institutional requirements for software usage
  • Could potentially limit adoption in professional/academic environments

Recommended alternatives:

  • MIT License: Simple, permissive, with clear liability disclaimers
  • BSD License: Well-recognized in academic communities
  • Apache 2.0: Comprehensive coverage of patents and contributions
🔗 Analysis chain

Review license choice for scientific software.

The WTFPL license might not be the most appropriate choice for scientific software as it lacks explicit terms for attribution, warranties, and liability. Consider suggesting a more standard license like MIT, BSD, or Apache 2.0.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check upstream license
# Expected: Should show actual license content from the source

# Test: Look for LICENSE file content in the package
curl -sL "https://raw.githubusercontent.com/art-egorov/msa4u/main/LICENSE"

Length of output: 557

@druvus
Copy link
Member Author

druvus commented Nov 3, 2024

@BiocondaBot please add label

@BiocondaBot BiocondaBot added the please review & merge set to ask for merge label Nov 3, 2024
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/msa4u/meta.yaml (2)

12-17: Consider relaxing version pinning and enabling build isolation.

  1. The x.x pin in run_exports might be too restrictive for a visualization tool. Consider using x instead unless there are known API breaking changes between minor versions.
  2. Building without isolation (--no-build-isolation) could lead to reproducibility issues.
  build:
    run_exports:    
-    - {{ pin_subpackage("msa4u", max_pin="x.x") }}
+    - {{ pin_subpackage("msa4u", max_pin="x") }}
-  script: {{ PYTHON }} -m pip install . -vv --no-deps --no-build-isolation
+  script: {{ PYTHON }} -m pip install . -vv --no-deps

1-40: Overall assessment: Recipe structure is good with minor improvements needed.

The recipe is well-structured and appropriate for Bioconda. Key points to address:

  1. Verify the 'configs' package requirement
  2. Consider enabling build isolation
  3. Consider relaxing version pinning in run_exports

The package fits Bioconda's scope as it's a biological sequence alignment visualization tool.

🧰 Tools
🪛 yamllint

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

(syntax)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 80a9337 and 9c2eba5.

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

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

(syntax)

🔇 Additional comments (4)
recipes/msa4u/meta.yaml (4)

1-6: LGTM! Package metadata is well-structured.

The package name and version are correctly templated using Jinja2, following conda-forge best practices.

🧰 Tools
🪛 yamllint

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

(syntax)


30-34: LGTM! Test section includes both import and CLI verification.

The tests appropriately verify both the Python package installation and CLI functionality.


28-28: Verify the 'configs' package requirement.

The 'configs' package is not a common Python package name. Please verify:

  1. Is this the correct package name?
  2. Is it available on conda-forge or bioconda?
#!/bin/bash
# Description: Check if configs package exists in conda channels
# Expected: Should find the package in conda-forge or bioconda

# Test: Search for configs package in conda channels
conda search configs -c conda-forge -c bioconda --info

8-10: Verify package source availability and integrity.

The source URL and checksum need verification to ensure the package can be downloaded successfully.

✅ Verification successful

Package source and checksum verified successfully

The PyPI package source is available and the SHA256 checksum matches exactly with the one specified in the recipe. The package can be downloaded from PyPI and its integrity is verified.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify package source availability and checksum
# Expected: Should be able to download the package and verify its checksum

# Test: Download the package and verify checksum
curl -sL "https://pypi.org/packages/source/m/msa4u/msa4u-0.4.0.tar.gz" | sha256sum

Length of output: 223


Script:

#!/bin/bash
# Let's verify the package source using a different approach
# First, let's check if the package exists on PyPI
curl -sI "https://pypi.org/pypi/msa4u/0.4.0/json" | head -n 1

# Then let's get the actual download URL and checksum from PyPI
curl -s "https://pypi.org/pypi/msa4u/0.4.0/json" | jq -r '.urls[] | select(.packagetype=="sdist") | "\(.url)\n\(.digests.sha256)"'

Length of output: 396

Comment on lines 36 to 37
about:
home: https://art-egorov.github.io/msa4u/
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

Homepage URL is not accessible

The specified homepage URL (https://art-egorov.github.io/msa4u/) returns a 404 error, indicating that the documentation site is not available. Please:

  • Update the homepage URL in recipes/msa4u/meta.yaml to point to a valid, accessible documentation site
  • Consider using the GitHub repository URL as a fallback if a dedicated documentation site is not yet published
🔗 Analysis chain

Verify homepage accessibility.

Let's ensure the documentation homepage is accessible and contains relevant information.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if the homepage is accessible
# Expected: Should return a successful status code

# Test: Check homepage availability
curl -sL -w "%{http_code}" "https://art-egorov.github.io/msa4u/" -o /dev/null

Length of output: 81

@bgruening bgruening merged commit f4f4918 into bioconda:master Nov 3, 2024
6 checks passed
@druvus druvus deleted the msa4u branch November 3, 2024 13:47
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