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 sopa package #51367

Merged
merged 1 commit into from
Oct 14, 2024
Merged

Add sopa package #51367

merged 1 commit into from
Oct 14, 2024

Conversation

quentinblampey
Copy link
Contributor

@quentinblampey quentinblampey commented Oct 14, 2024

Adding the sopa package to bioconda


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 14, 2024

📝 Walkthrough

Walkthrough

The pull request introduces a new YAML configuration file for the "sopa" package, specifying its metadata and build specifications. The package is named "sopa" with a version of "1.1.5". It includes a source URL pointing to a tarball on PyPI, along with a SHA256 checksum for verification. The build section defines an entry point for the application, indicating that it can be accessed via sopa.main:app. The package is marked as architecture-independent and includes a script for installation via pip without dependencies or build isolation. The requirements section is categorized into host and run, detailing necessary Python version constraints and dependencies like spatialdata, scanpy, and pytorch. The test section outlines commands for checking dependencies and displaying help information. Additionally, the about section provides a homepage, summary, and licensing details, while the extra section lists the recipe maintainers.

Possibly related PRs

  • add sipros #51091: The meta.yaml file for the "sipros" package introduces a new package configuration similar to the changes made in the "sopa" package's meta.yaml, including package name, version, source URL, and requirements.
  • Add Snk #51152: The meta.yaml for the "snk" package also establishes a new package configuration, including similar elements such as package name, version, source URL, and requirements, paralleling the structure of the "sopa" package's configuration.
  • Add Snk-CLI #51153: The meta.yaml for the "snk-cli" package follows the same pattern of defining package metadata, including name, version, source URL, and requirements, akin to the changes made in the "sopa" 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: 0

🧹 Outside diff range and nitpick comments (3)
sopa/meta.yaml (3)

19-52: Requirements section is well-structured, but consider reviewing version constraints.

The requirements section is well-organized with separate host and run requirements. The use of run_constrained for optional dependencies is a good practice. However, some dependencies have very specific version constraints, which might lead to conflicts or maintenance issues in the future.

Consider reviewing and possibly relaxing some version constraints, especially for dependencies that are not directly related to the core functionality of the package. For example:

-    - flake8 <8.0.0,>=7.0.0
+    - flake8 >=7.0.0,<8.0.0
-    - snakemake >=7.32.4,<8.0.0,<8.1.3
+    - snakemake >=7.32.4,<8.2.0
-    - pulp >=2.3.1,<3.0.0,<2.8
+    - pulp >=2.3.1,<3.0.0

This will make the package more flexible and easier to maintain in the long run.


53-60: Test section is good, but consider adding more comprehensive tests.

The test section includes basic checks like importing the package, verifying dependencies with pip check, and running the CLI help command. These are good starting points.

To improve the test coverage, consider adding more comprehensive tests:

  1. Add unit tests for core functionalities.
  2. Include integration tests if applicable.
  3. Test with different input data or configurations.

Example addition:

  commands:
    - pip check
    - sopa --help
    - python -m pytest tests/

This assumes you have a tests/ directory with pytest-compatible tests. If not, I can help you set up a basic test structure.


68-70: Extra section is good, but consider adding more maintainers.

The extra section correctly lists the recipe maintainer. However, having only one maintainer (quentinblampey) might be a potential single point of failure for package maintenance.

Consider adding more maintainers to ensure continued support and maintenance of the package. This can be done by adding more GitHub usernames to the list:

extra:
  recipe-maintainers:
    - quentinblampey
    - another_maintainer
    - yet_another_maintainer
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between a8fe9ad and 090cc13.

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

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

(syntax)

🔇 Additional comments (4)
sopa/meta.yaml (4)

1-10: LGTM: Package and source information looks good.

The package name and version are correctly defined using Jinja2 variables, which is a good practice for maintainability. The source URL follows the PyPI convention, and the SHA256 checksum is provided for integrity verification.

🧰 Tools
🪛 yamllint

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

(syntax)


62-66: LGTM: About section is well-defined.

The about section provides all necessary information including the home page, a concise summary, and correct license details. The BSD-3-Clause license is appropriately specified, and the license file is correctly referenced.


1-2: Note: Ignore yamllint syntax error for '%' character.

The yamllint tool reported a syntax error for the '%' character at the beginning of the file. This is a false positive. The '%' character is part of the Jinja2 template syntax, which is correctly used here and follows Conda packaging best practices.

🧰 Tools
🪛 yamllint

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

(syntax)


12-17: Build section looks good, but consider installation flags.

The build section is well-defined with the correct entry point and noarch: python setting. However, the installation script uses --no-deps and --no-build-isolation flags, which might cause issues if not handled carefully.

Please ensure that all dependencies are correctly specified in the requirements section, as --no-deps will prevent pip from installing or upgrading dependencies. Also, verify that the package doesn't require any build-time dependencies that might be affected by --no-build-isolation.

@quentinblampey
Copy link
Contributor Author

@BiocondaBot please add label

@martin-g martin-g merged commit fe9fa8e into bioconda:master Oct 14, 2024
7 checks passed
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