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 mikrokondo-tools #51618

Merged
merged 7 commits into from
Oct 23, 2024
Merged

Add mikrokondo-tools #51618

merged 7 commits into from
Oct 23, 2024

Conversation

mattheww95
Copy link
Contributor

added bioconda recipe for mikrokondo-tools

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

@mattheww95 mattheww95 marked this pull request as ready for review October 23, 2024 18:27
@mattheww95
Copy link
Contributor Author

mattheww95 commented Oct 23, 2024

@bioconda/core

@BiocondaBot
Copy link
Collaborator

Reposting for @mattheww95 to enable pings (courtesy of the BiocondaBot):

@bioconda/core.

Copy link
Contributor

coderabbitai bot commented Oct 23, 2024

📝 Walkthrough
📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request introduces a new file, meta.yaml, for the mikrokondo-tools package, version 0.0.1rc0. This file outlines the package configuration, including the package name, version, source URL from PyPI, and a SHA256 checksum for integrity verification. The build section specifies the entry point for the command-line interface and notes that the package is architecture-independent. Additionally, it includes a requirements section that lists dependencies for both host and runtime environments, specifying a minimum Python version of 3.8 and essential packages such as click, requests, and jsonschema. The test section provides commands to verify the installation and check for dependency issues. The about section contains metadata, including the homepage, summary, development URL, license type, and a reference to the license file. An extra section identifies the recipe maintainers for the package.

Possibly related PRs

  • [recipe for pgrc #50973] Recipe for pgrc: This PR introduces a new meta.yaml file for the pgrc package, which also includes a structured configuration similar to the changes made in the main PR for mikrokondo-tools.
  • [Add Snk #51152] Add Snk: This PR adds a new meta.yaml file for the snk package, which includes similar elements such as package name, version, source URL, and SHA256 checksum, paralleling the updates in the main PR.
  • [Add recipe for mini3di. #51211] Add recipe for mini3di: This PR introduces a new meta.yaml file for the mini3di package, which shares the same structure and elements as the meta.yaml file updated in the main PR.
  • [Add seqspec #51326] Add seqspec: This PR adds a new meta.yaml file for the seqspec package, which includes similar configurations and requirements as those defined in the main PR for mikrokondo-tools.
  • [Add meta_eukaryome_detect #51328] Add meta_eukaryome_detect: This PR introduces a new meta.yml file for the meta_eukaryome_detect package, which follows the same pattern of defining package metadata and dependencies as seen in the main PR.
  • [Add pykofamsearch #51537] Add pykofamsearch: This PR adds a new meta.yaml file for the pykofamsearch package, which includes similar structural elements and requirements as the meta.yaml file updated in the main PR.

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

🧹 Outside diff range and nitpick comments (2)
recipes/mikrokondo-tools/meta.yaml (2)

26-30: Add version constraints for runtime dependencies

To ensure reproducibility and prevent breaking changes, consider adding version constraints for runtime dependencies:

   run:
     - python >=3.8
-    - click
-    - requests
-    - jsonschema
+    - click >=8.0
+    - requests >=2.0
+    - jsonschema >=3.0

32-39: Consider adding more comprehensive tests

While the current tests cover basic functionality, consider adding:

  1. Tests for specific CLI subcommands if available
  2. Tests for key package functionality

Would you like help generating additional test commands based on the package's functionality?

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 2c0174a and 9aeb4ae.

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

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

(syntax)

🔇 Additional comments (2)
recipes/mikrokondo-tools/meta.yaml (2)

1-6: Verify if using a release candidate version is intended

The package version 0.0.1rc0 indicates this is a release candidate. Consider if a stable release would be more appropriate for Bioconda distribution.

🧰 Tools
🪛 yamllint

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

(syntax)


48-50: Verify maintainer GitHub username

Please ensure that the GitHub username 'mwells' is correct and that they have agreed to maintain this package.

recipes/mikrokondo-tools/meta.yaml Outdated Show resolved Hide resolved
recipes/mikrokondo-tools/meta.yaml Show resolved Hide resolved
recipes/mikrokondo-tools/meta.yaml Outdated Show resolved Hide resolved

extra:
recipe-maintainers:
- mwells
Copy link
Member

Choose a reason for hiding this comment

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

This should be your github handle currently points to a Mike Wells (https://github.com/mwells)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you!

mattheww95 and others added 2 commits October 23, 2024 13:35
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@mattheww95 mattheww95 requested a review from rpetit3 October 23, 2024 19:04
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: 1

🧹 Outside diff range and nitpick comments (1)
recipes/mikrokondo-tools/meta.yaml (1)

21-30: Consider specifying version constraints for dependencies

While the Python version constraint is good, consider adding version constraints for other dependencies to ensure compatibility and reproducibility.

   run:
     - python >=3.8
-    - click
-    - requests
-    - jsonschema
+    - click >=8.0
+    - requests >=2.0
+    - jsonschema >=3.0
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 9aeb4ae and 2895efa.

📒 Files selected for processing (1)
  • recipes/mikrokondo-tools/meta.yaml (1 hunks)
🧰 Additional context used
📓 Learnings (1)
recipes/mikrokondo-tools/meta.yaml (1)
Learnt from: rpetit3
PR: bioconda/bioconda-recipes#51618
File: recipes/mikrokondo-tools/meta.yaml:18-19
Timestamp: 2024-10-23T18:36:53.267Z
Learning: In Bioconda recipes, the `run_exports` section is sometimes required in `meta.yaml` to pass linting, even for pure Python packages.
🪛 yamllint
recipes/mikrokondo-tools/meta.yaml

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

(syntax)

🔇 Additional comments (5)
recipes/mikrokondo-tools/meta.yaml (5)

12-19: Build configuration looks good

The build configuration is well-structured with:

  • Correct entry point definition
  • Appropriate noarch specification
  • Standard pip installation
  • Required run_exports section for linting

32-39: Test configuration is comprehensive

Good test coverage with:

  • Package import verification
  • Dependency compatibility check
  • CLI functionality test

48-50: Maintainer configuration is correct

The recipe maintainer is properly specified.


1-6: Verify package version availability on PyPI

The version 0.0.1rc0 indicates this is a release candidate. Let's ensure this version is published and available.

✅ Verification successful

Since the shell script output shows that version 0.0.1rc0 exists on PyPI, I can now generate the final response.

Version 0.0.1rc0 is correctly specified and available on PyPI

The package version specified in the recipe matches the published version on PyPI, which ensures the recipe can be built successfully.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify package version exists on PyPI
curl -s "https://pypi.org/pypi/mikrokondo-tools/json" | jq -r '.releases | keys[]' | grep "0.0.1rc0" || echo "Version not found on PyPI"

Length of output: 107

🧰 Tools
🪛 yamllint

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

(syntax)


8-10: Verify SHA256 checksum

Let's verify the provided SHA256 checksum matches the source package.

recipes/mikrokondo-tools/meta.yaml Show resolved Hide resolved
@rpetit3
Copy link
Member

rpetit3 commented Oct 23, 2024

@BiocondaBot please fetch artifacts

@BiocondaBot
Copy link
Collaborator

Package(s) built are ready for inspection:

Arch Package Zip File / Repodata CI Instructions
noarch mikrokondo-tools-0.0.1rc0-pyhdfd78af_0.tar.bz2 LinuxArtifacts.zip Azure
showYou may also use conda to install after downloading and extracting the zip file. From the LinuxArtifacts directory: conda install -c ./packages <package name>

Docker image(s) built:

Package Tag CI Install with docker
mikrokondo-tools 0.0.1rc0--pyhdfd78af_0 Azure
showImages for Azure are in the LinuxArtifacts zip file above.gzip -dc LinuxArtifacts/images/mikrokondo-tools:0.0.1rc0--pyhdfd78af_0.tar.gz | docker load

@rpetit3 rpetit3 merged commit 500d734 into bioconda:master Oct 23, 2024
7 checks passed
@coderabbitai coderabbitai bot mentioned this pull request Nov 5, 2024
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