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 coptr #51764

Merged
merged 1 commit into from
Oct 29, 2024
Merged

Add coptr #51764

merged 1 commit into from
Oct 29, 2024

Conversation

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

@ramirobarrantes
Copy link
Contributor Author

@BiocondaBot Please add label

@BiocondaBot BiocondaBot added the please review & merge set to ask for merge label Oct 29, 2024
Copy link
Contributor

coderabbitai bot commented Oct 29, 2024

📝 Walkthrough

Walkthrough

The pull request introduces a new file named meta.yaml for the coptr software package. This file establishes the package's configuration, setting the name to "coptr" and the version to "1.1.4". It includes a source section with a URL for downloading the package from PyPI and a SHA256 checksum for integrity verification. The build section specifies that the cli function from the coptr.cli module serves as the main entry point and that the package will be installed using Python's pip without dependencies or build isolation. The requirements section lists the necessary dependencies for both host and runtime environments, including specific versions for Python, setuptools, wheel, pip, numpy, pysam, scipy, and matplotlib-base. Additionally, the test section outlines commands to verify the installation and functionality of the package. Metadata about the package, such as its homepage, summary, licensing information, and maintainers, is also included.

Possibly related PRs

  • recipe for pgrc #50973: The meta.yaml file for the pgrc package also defines package configuration, including dependencies and entry points, similar to the changes made in the coptr package's meta.yaml.
  • Add patchify #51268: The meta.yaml for the patchify package introduces a new package configuration, including dependencies and entry points, akin to the modifications in the coptr package's meta.yaml.
  • Add seqspec #51326: The meta.yaml for the seqspec package outlines package configuration, dependencies, and entry points, paralleling the structure and purpose of the coptr package's meta.yaml.
  • Add gene-trajectory-python recipe #51476: The meta.yaml for the gene-trajectory-python package includes similar elements such as package configuration, dependencies, and entry points, reflecting the changes made in the coptr package's meta.yaml.
  • Add mikrokondo-tools #51618: The meta.yaml for the mikrokondo-tools package also defines package configuration, dependencies, and entry points, which aligns with the changes in the coptr package's meta.yaml.

Suggested labels

please review & merge

Suggested reviewers

  • martin-g
  • 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: 0

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

34-41: Consider enhancing test coverage.

While basic testing is present, consider adding more comprehensive tests:

  • Test basic functionality with a small example
  • Verify version command works: coptr --version
 test:
   imports:
     - coptr
   commands:
     - pip check
     - coptr --help
+    - coptr --version
   requires:
     - pip
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between f83e9c7 and 2215989.

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

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

(syntax)

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

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

The package name and version are properly defined using Jinja2 variables, following conda-forge best practices.

🧰 Tools
🪛 yamllint

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

(syntax)


12-19: LGTM! Build configuration follows best practices.

The build section is well-configured with:

  • Proper entry point definition
  • Appropriate use of noarch: python
  • Correct implementation of run_exports for version pinning

43-51: LGTM! Package metadata is complete and appropriate.

The about section properly defines:

  • License information with license file
  • Relevant biological application in summary
  • Appropriate maintainer configuration

8-10: Verify PyPI package URL and checksum.

The source configuration looks correct, but let's verify the package availability and checksum.


21-32: Consider adding run_exports for critical dependencies.

While the dependencies are well-defined, consider whether numpy, pysam, or scipy should use run_exports to prevent ABI incompatibilities.

@jfy133 jfy133 self-requested a review October 29, 2024 10:48
@jfy133 jfy133 merged commit 0156829 into bioconda:master Oct 29, 2024
6 checks passed
@coderabbitai coderabbitai bot mentioned this pull request Oct 29, 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