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 package doubletdetection #51786

Merged
merged 3 commits into from
Oct 30, 2024
Merged

Conversation

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

@LeonHafner LeonHafner marked this pull request as draft October 29, 2024 18:51
Copy link
Contributor

coderabbitai bot commented Oct 29, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request introduces an updated meta.yaml file for the doubletdetection package, detailing essential package metadata and dependencies required for building and running the software. The package name is defined as "doubletdetection" with a version of "4.2". The source section includes a URL for downloading the package from PyPI and a SHA256 checksum for integrity verification. The build section indicates that the package is architecture-independent and provides a script for installation using pip without dependencies or build isolation. Host requirements specify compatible Python versions and essential libraries, while runtime requirements include libraries such as anndata, numpy, and pandas. Additionally, constrained runtime dependencies for development tools like black, flake8, and pytest are included. The test section specifies imports to verify the installation of the package. The about section provides metadata, including the project's homepage, summary, license type, and license file reference. The recipe maintainers for the package are also listed.

Possibly related PRs

  • Update meta.yaml for spec2vec #49857: The update to meta.yaml for spec2vec includes changes to the requirements section and build script, similar to the modifications made in the meta.yaml for doubletdetection, which also specifies dependencies and build instructions.
  • Add meta_eukaryome_detect #51328: The meta_eukaryome_detect PR updates its meta.yml with a structured configuration that includes dependencies and build instructions, paralleling the changes made in the doubletdetection package's meta.yaml.

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

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

49-56: Enhance test coverage.

The current tests only verify import and dependencies. Consider adding functional tests to verify key package capabilities.

Add basic functionality tests, for example:

  test:
    imports:
      - doubletdetection
    commands:
      - pip check
+     - python -c "import doubletdetection; assert hasattr(doubletdetection, 'BoostClassifier')"
    requires:
      - pip
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 2290368 and d6034c8.

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

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

(syntax)

🔇 Additional comments (2)
recipes/doubletdetection/meta.yaml (2)

57-61: Verify license file and repository URL.

Please ensure:

  1. The LICENSE.txt file exists in the source distribution
  2. The GitHub repository URL is correct and accessible
✅ Verification successful

Repository URL and license file verified successfully

Both checks passed:

  • GitHub repository is accessible (HTTP 200)
  • LICENSE.txt file exists in the source distribution
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify license file and repository
# Expected: License file exists and repository is accessible

# Check if repository exists and is accessible
curl -s -o /dev/null -w "%{http_code}" "https://github.com/JonathanShor/DoubletDetection"

# Download source and check for license file
curl -sL "https://pypi.org/packages/source/d/doubletdetection/doubletdetection-4.2.tar.gz" | tar tz | grep -i "license"

Length of output: 243


8-10: Verify package availability and checksum.

The source URL follows PyPI conventions, but let's verify its existence and integrity.

Comment on lines +18 to +24
host:
- python >=3.6,<4.0
- poetry >=1.0
- setuptools
- poetry-core
- pip
run:
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Align Python version constraints between host and run sections.

The Python version requirements are inconsistent:

  • host: python >=3.6,<4.0
  • run: python >=3.6.1,<4.0

This could potentially cause build issues.

  host:
-   - python >=3.6,<4.0
+   - python >=3.6.1,<4.0
    - poetry >=1.0

Also applies to: 25-36

Comment on lines +37 to +47
run_constrained:
- black >=20.8b1
- flake8 >=3.7.7
- furo *
- myst-parser *
- nbsphinx *
- nbsphinx-link *
- pre-commit >=2.7.1
- pytest >=4.4
- sphinx >=4.1,<4.4
- sphinx-autodoc-typehints *
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Consider moving development dependencies to optional features.

The run_constrained section includes development tools that aren't required for normal package operation. Consider making these optional to reduce the dependency footprint.

You could move these to optional features using outputs section or create a separate -dev package. Would you like me to provide an example implementation?

@LeonHafner LeonHafner marked this pull request as ready for review October 29, 2024 23:43
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/doubletdetection/meta.yaml (1)

51-53: Consider enhancing test coverage.

The current test only verifies that the package can be imported. Consider adding:

  • Command line interface tests if applicable
  • Basic functionality tests to ensure core features work

Example enhancement:

 test:
   imports:
     - doubletdetection
+  commands:
+    - python -c "import doubletdetection; assert doubletdetection.__version__ == '4.2'"
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between d6034c8 and e199ec8.

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

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

(syntax)

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

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

The package name and version are correctly templated using Jinja2 syntax.

🧰 Tools
🪛 yamllint

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

(syntax)


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

  • noarch: python is appropriate for this pure Python package
  • pip install flags prevent dependency conflicts
  • run_exports correctly pins the package version

55-66: LGTM! Package metadata is complete.

All required metadata fields are present and properly filled:

  • Project links (home, dev_url, doc_url)
  • License information
  • Maintainer information

8-10: Verify source package availability and integrity.

The source URL follows PyPI's standard format, and a SHA256 checksum is provided.

✅ Verification successful

Source package URL and checksum verified successfully

The package is available on PyPI and the SHA256 checksum in the recipe (77273d543a7c9b4f4e795b7b664c28bce0613b3a3a7c7f5137974012400a0a6c) matches exactly with the official checksum from PyPI. The source configuration is correct and secure.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify package availability and checksum on PyPI
# Expected: URL should be accessible and checksum should match

# Test: Check if the package exists on PyPI
curl -s -o /dev/null -w "%{http_code}" "https://pypi.org/packages/source/d/doubletdetection/doubletdetection-4.2.tar.gz"

# Test: Download and verify checksum
curl -sL "https://pypi.org/packages/source/d/doubletdetection/doubletdetection-4.2.tar.gz" | sha256sum

Length of output: 303


Script:

#!/bin/bash
# Let's try a different approach using wget to download and verify
# First, check if the package exists on PyPI API
curl -s "https://pypi.org/pypi/doubletdetection/json" | jq -r '.urls[] | select(.filename == "doubletdetection-4.2.tar.gz") | .url'

# Get the package information from PyPI
curl -s "https://pypi.org/pypi/doubletdetection/json" | jq -r '.urls[] | select(.filename == "doubletdetection-4.2.tar.gz") | {url, digests}'

Length of output: 793


26-38: Consider adding upper bounds to dependencies.

Several runtime dependencies lack upper version bounds, which could lead to compatibility issues in the future. Consider adding upper bounds to critical dependencies:

Suggested bounds based on current stable versions:

    - anndata >=0.6
+   - anndata >=0.6,<0.10.0
    - ipywidgets
+   - ipywidgets <9.0.0
    - leidenalg
+   - leidenalg <0.10.0
    - louvain
+   - louvain <0.8.0
    - phenograph
+   - phenograph <1.6.0
    - scanpy >1.4.4
+   - scanpy >1.4.4,<1.10.0

@mencian mencian merged commit 890c4fd into bioconda:master Oct 30, 2024
6 checks passed
@LeonHafner LeonHafner deleted the doubletdetection branch October 30, 2024 07:33
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.

2 participants