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

Update decom recipe to version 0.0.32 and align dependencies #51723

Merged
merged 8 commits into from
Oct 29, 2024

Conversation

CamilaDuitama
Copy link
Contributor

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 28, 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 12 minutes and 11 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

Files that changed from the base of the PR and between 5d8abc8 and 51429ba.

📝 Walkthrough
📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request introduces modifications to the meta.yaml file for the decOM package. Key changes include dynamically setting the package name to lowercase using a Jinja template, updating the source URL, and incrementing the build number from 0 to 1. The run_exports section has been reintroduced with a new format, specifying maximum pinning versions for dependencies. The Python version constraint has been refined to >=3.6, and several dependencies now have specific version constraints, replacing previous unbounded entries. The test section has been expanded to include additional imports for various submodules of decOM. The summary has been updated to a more concise description, and documentation and development URLs have been updated to point to the same GitHub repository, while the home URL remains unchanged. These changes reflect a shift towards more precise dependency management and a dynamic configuration for the package name.

Possibly related PRs

  • Update meta.yaml for spec2vec #49857: Updates to the meta.yaml file for the spec2vec package include changes to the build number and the run_exports section.
  • 2024.4 #50977: Modifications to the meta.yaml file for biobb_structure_checking include a version change and SHA256 checksum update.
  • update Hsdecipher des #51023: Updates to the hsdecipher package's meta.yaml file include a build number increment and updates to the command in the test section.
  • Update Hsdecipher #51093: The hsdecipher package's version update and checksum change in its meta.yaml is consistent with the versioning updates in the decOM package.
  • Update meta_eukaryome_detect: Rename meta.yml to meta.yaml #51366: The update to the meta.yaml for meta_eukaryome_detect includes a version increment and dependency formatting changes, similar to the structured updates in the decOM package.
  • Update matchms dependencies #51552: The matchms package's meta.yaml shows a version increment and updates to multiple dependencies, reflecting the dependency management approach taken in the decOM package.

Suggested reviewers

  • martin-g

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

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

10-11: Remove redundant SHA256 comment

The comment "Update this if necessary" is redundant since SHA256 checksums must always match the source package exactly. Consider removing this comment to avoid confusion.

-  sha256: c9efaa97b7abfe6f19f01a199ca6c7a7b32ec699f886d226667b8b5fe562dd88  # Update this if necessary
+  sha256: c9efaa97b7abfe6f19f01a199ca6c7a7b32ec699f886d226667b8b5fe562dd88
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 9a03cf0 and 0433678.

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

[error] 63-63: trailing spaces

(trailing-spaces)


[error] 64-64: trailing spaces

(trailing-spaces)

🔇 Additional comments (5)
recipes/decom/meta.yaml (5)

5-6: LGTM: Package naming follows best practices

The change to lowercase package naming using Jinja templating aligns with Python packaging conventions.


Line range hint 13-22: LGTM: Build configuration is correct

The build number increment is appropriate for the dependency updates, and entry points are properly configured.


40-48: LGTM: Comprehensive test configuration

The test configuration is thorough, covering all major modules and command-line interfaces.


61-64: ⚠️ Potential issue

Add missing metadata fields

Several important metadata fields are empty:

  1. license_file should point to the LICENSE file in the package
  2. doc_url and dev_url should be populated to improve package discoverability

The previous values were:

Please verify if these URLs are still valid and restore them if appropriate.

✅ Verification successful

Add LICENSE file path and restore documentation URLs

The verification shows:

  1. A LICENSE file exists at the repository root that can be referenced
  2. Both documentation URLs are still valid and accessible:

Please update the metadata fields:

license_file: LICENSE
doc_url: https://github.com/CamilaDuitama/decOM
dev_url: https://camiladuitama.github.io/gradfolio/
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if LICENSE file exists in the package
fd -t f -i "license"

# Verify if the documentation URLs are still valid
curl -I https://github.com/CamilaDuitama/decOM
curl -I https://camiladuitama.github.io/gradfolio/

Length of output: 14238

🧰 Tools
🪛 yamllint

[error] 63-63: trailing spaces

(trailing-spaces)


[error] 64-64: trailing spaces

(trailing-spaces)


27-36: Consider more flexible version constraints

The current version constraints might be overly restrictive:

  1. Limiting Python to 3.12 only might unnecessarily exclude compatible Python versions
  2. Very tight version constraints (e.g., pandas >=2.2.3,<2.3) could cause dependency resolution issues

Consider:

  • Supporting a broader Python range (e.g., >=3.9)
  • Using more flexible version constraints unless there are known compatibility issues

@CamilaDuitama
Copy link
Contributor Author

@BiocondaBot please add label

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

68-69: Consider adding documentation and development URLs.

The doc_url and dev_url fields are empty. Consider adding:

  • doc_url pointing to the GitHub repository (since it contains documentation)
  • dev_url pointing to the GitHub repository for development references
-  doc_url: 
-  dev_url: 
+  doc_url: https://github.com/CamilaDuitama/decOM
+  dev_url: https://github.com/CamilaDuitama/decOM
🧰 Tools
🪛 yamllint

[error] 68-68: trailing spaces

(trailing-spaces)


[error] 69-69: trailing spaces

(trailing-spaces)


65-67: Fix trailing spaces in description.

Remove trailing spaces from the description field to resolve yamllint warnings.

-    decOM is a similarity-based microbial source tracking tool for 
-    contamination assessment of ancient oral samples using k-mer-based methods.
+    decOM is a similarity-based microbial source tracking tool for
+    contamination assessment of ancient oral samples using k-mer-based methods.
🧰 Tools
🪛 yamllint

[error] 66-66: trailing spaces

(trailing-spaces)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 0433678 and 74b3a32.

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

[error] 66-66: trailing spaces

(trailing-spaces)


[error] 68-68: trailing spaces

(trailing-spaces)


[error] 69-69: trailing spaces

(trailing-spaces)

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

5-5: LGTM: Package naming follows Conda best practices.

The change to lowercase package name using Jinja template is correct and follows Conda packaging conventions.


42-50: LGTM: Comprehensive test imports.

The test imports cover all major submodules, providing good coverage for package integrity verification.


29-38: ⚠️ Potential issue

Ensure consistent dependency version constraints.

A few observations about the dependency specifications:

  1. The Python requirement (>=3.12,<3.13) is very restrictive. Consider if this is intentional as it limits the package to only Python 3.12.
  2. Some dependencies have upper bounds (numpy, pandas, plotly) while others (dask, importlib_resources) don't. Consider adding upper bounds for consistency.

Let's verify if other packages support this Python version:

#!/bin/bash
# Check Python version constraints in dependencies
echo "Checking dask Python requirements:"
rg -A 2 'name: "dask"' . | rg 'python'
echo "Checking pandas Python requirements:"
rg -A 2 'name: "pandas"' . | rg 'python'

23-24: 🛠️ Refactor suggestion

Consider relaxing the version pinning strategy.

The current max_pin='x.x.x' is very restrictive, requiring an exact version match. For a package at version 0.0.32 (pre-1.0), consider using a more relaxed pinning strategy like max_pin='x.x' to allow patch-level updates, unless there are specific ABI compatibility concerns.

summary: "decOM: Similarity-based microbial source tracking for contamination assessment of ancient oral samples using k-mer-based methods"
doc_url: "https://github.com/CamilaDuitama/decOM"
dev_url: "https://camiladuitama.github.io/gradfolio/"
license_file:
Copy link
Contributor

@coderabbitai coderabbitai bot Oct 28, 2024

Choose a reason for hiding this comment

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

⚠️ Potential issue

Add the license file specification.

The license_file field is empty but the package is MIT licensed. This field should point to the LICENSE file in the source distribution.

Please add:

-  license_file: 
+  license_file: LICENSE
📝 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
license_file:
license_file: LICENSE

Copy link
Member

Choose a reason for hiding this comment

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

Please add a license file

Copy link
Contributor

Choose a reason for hiding this comment

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

@bgruening, thank you for pointing that out. Please ensure that the LICENSE file is included in the source distribution and update the license_file field in meta.yaml accordingly.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The PyPI distribution includes the LICENSE file. I added a pointer to the meta.yaml file; I hope this fixes the issue.

Copy link
Contributor

Choose a reason for hiding this comment

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

Seems like the humans are having a chat. I'll hop back into my burrow for now. If you need me again, just tag @coderabbitai in a new comment, and I'll come hopping out!

- pandas
- plotly >=5.5.0
- python
- python >=3.12,<3.13
Copy link
Member

Choose a reason for hiding this comment

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

Why are so strict pinning needed?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I removed the strict pinning

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 (1)
recipes/decom/meta.yaml (1)

69-70: Consider separating documentation and development URLs

Both doc_url and dev_url point to the same GitHub repository. Consider:

  • Creating dedicated documentation (e.g., using GitHub Pages, ReadTheDocs)
  • Using the documentation URL for doc_url and keeping the GitHub repository for dev_url
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between db34062 and 4261ec5.

📒 Files selected for processing (1)
  • recipes/decom/meta.yaml (3 hunks)
🔇 Additional comments (4)
recipes/decom/meta.yaml (4)

Line range hint 13-24: LGTM: Build configuration follows best practices

The build configuration is well structured with:

  • Appropriate build number increment
  • Correct entry points configuration
  • Good pinning strategy in run_exports

44-52: LGTM: Comprehensive test coverage

The test section provides good coverage by:

  • Testing imports of all main modules
  • Including command-line interface tests

29-40: Consider relaxing version constraints

The current version constraints might be overly restrictive:

  1. Python 3.12-3.14 is a very narrow range and 3.12 is quite recent
  2. Dependencies like numpy, pandas, and dask are pinned to very recent versions

This could limit the package's compatibility with other tools in the bioconda ecosystem. Consider:

  • Supporting Python 3.8+ unless there's a specific need for 3.12 features
  • Relaxing dependency version upper bounds unless there are known compatibility issues
#!/bin/bash
# Check other bioconda packages' Python compatibility
rg "python.*3\.12" | grep "run:"

9-11: Verify the SHA256 checksum for version 0.0.32

Please verify that the SHA256 checksum matches the source tarball for version 0.0.32.

@CamilaDuitama
Copy link
Contributor Author

@BiocondaBot please add label

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.

4 participants