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 SpreadGLtools #50627

Merged
merged 13 commits into from
Sep 30, 2024
Merged

Add SpreadGLtools #50627

merged 13 commits into from
Sep 30, 2024

Conversation

Joon-Klaps
Copy link
Contributor

@Joon-Klaps Joon-Klaps commented Sep 11, 2024

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

Summary by CodeRabbit

  • New Features
    • Introduced the SpreadGLtools package (version 1.1.0) for enhanced geospatial data processing.
  • Dependencies
    • Added support for Python 3.11 and various essential libraries including NumPy, Pandas, GeoPandas, and others.
  • Tests
    • Implemented test commands to verify the functionality of key package commands, such as spread --help, rates --help, and others.

recipes/spreadgltools/meta.yaml Outdated Show resolved Hide resolved
recipes/spreadgltools/meta.yaml Outdated Show resolved Hide resolved
recipes/spreadgltools/meta.yaml Outdated Show resolved Hide resolved
Copy link
Contributor

coderabbitai bot commented Sep 30, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

This pull request introduces the SpreadGLtools package version 1.1.0, detailing its configuration in the meta.yaml file. Key updates include the addition of multiple dependencies necessary for geospatial data processing and the inclusion of test commands to verify package functionality. The file also specifies the package's source URL and integrity verification details.

Changes

Files Change Summary
recipes/spreadgltools/meta.yaml - Added package SpreadGLtools version 1.1.0
- Added dependencies for Python, NumPy, Pandas, and other libraries
- Included test commands for various package functionalities

Possibly related PRs

  • 2024.4 #50977: This PR updates the meta.yaml file for the biobb_structure_checking package, which is similar to the main PR that also modifies a meta.yaml file for the SpreadGLtools package.

Suggested reviewers

  • gbayarri

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

24-41: LGTM with minor suggestions: Requirements section is comprehensive.

The requirements are well-defined with appropriate version constraints. However, consider standardizing package names to lowercase for consistency:

-    - Dendropy >=4.5.2
+    - dendropy >=4.5.2
-    - Cython >=0.29.35
+    - cython >=0.29.35
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 10ec055 and 85a1e62.

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

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

(syntax)

🔇 Additional comments (6)
recipes/spreadgltools/meta.yaml (6)

1-7: LGTM: Package and version section looks good.

The package name, version, and SHA256 checksum are correctly defined. The use of Jinja2 templating and lowercasing the package name in the declaration follow best practices.

🧰 Tools
🪛 yamllint

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

(syntax)


9-11: LGTM: Source section is correctly defined.

The source URL now points to a specific GitHub tag, addressing the previous comment about using a moving target. The SHA256 checksum is correctly referenced.


13-22: LGTM: Build section is well-defined.

The build configuration is correct:

  • Build number is set to 0 for a new package.
  • noarch: python is appropriate for this package.
  • The SETUPTOOLS_SCM_PRETEND_VERSION environment variable is correctly set.
  • The build script correctly installs from the 'scripts' directory.
  • The run_exports section is included as recommended.

43-50: LGTM: Test section is well-defined.

The test commands cover all major components of the package, which is good for verifying basic functionality.


52-56: LGTM: About section provides necessary metadata.

The license, summary, and documentation URL are correctly specified, providing essential metadata for the package.


1-1: Note on yamllint warning: False positive.

The yamllint tool reports a syntax error for the '%' character at the beginning of the file. This is a false positive as the '%' is part of the Jinja2 templating syntax, which is valid and commonly used in Conda recipe files.

🧰 Tools
🪛 yamllint

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

(syntax)

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)
recipes/spreadgltools/meta.yaml (3)

24-40: LGTM with suggestions: Requirements are comprehensive but some version constraints might be too restrictive.

The requirements section is well-defined with appropriate version constraints. However, consider the following suggestions:

  1. The Python requirement (>=3.11) might limit compatibility with some systems. Consider if a lower version would suffice.
  2. Some package version constraints (e.g., pandas >=2.2.0) are very specific. Unless these exact versions are necessary, consider relaxing these constraints for better compatibility across different environments.

42-49: LGTM with suggestions: Test commands cover basic CLI functionality.

The test section includes commands to check the help output of various package functions, which is good for ensuring basic CLI functionality. However, consider enhancing the test coverage:

  1. Add an import test to ensure the package can be imported correctly:
    imports:
      - spreadgltools
  2. If possible, include some basic functional tests that exercise the core functionality of the package.

51-56: LGTM with suggestions: About section provides essential metadata.

The about section includes the necessary information such as home URL, license, and a brief summary. The license is correctly specified as MIT, addressing a previous comment. Consider the following enhancements:

  1. Add a description field with a more detailed explanation of the package's functionality.
  2. Include a dev_url pointing to the GitHub repository for development-related information.
  3. If available, add a license_file field specifying the location of the license file in the source distribution.
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 85a1e62 and b0b7e33.

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

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

(syntax)

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

1-7: LGTM: Package and version information looks good.

The package name, version, and SHA256 checksum are correctly defined using Jinja2 templating.

🧰 Tools
🪛 yamllint

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

(syntax)


9-11: LGTM: Source URL and checksum are correctly specified.

The use of a specific GitHub tag (v{{ version }}) addresses the previous concern about using a moving target. This ensures reproducibility and stability.


13-22: LGTM: Build configuration is correct and follows Bioconda guidelines.

The build section is well-configured:

  • Appropriate use of noarch: python for a Python package.
  • Correct implementation of run_exports for version pinning.
  • The build script uses pip for installation, which is standard practice.

58-60: LGTM: Extra section includes DOI identifier.

The inclusion of the DOI in the extra section is excellent practice for scientific software, enhancing discoverability and citability.

@Joon-Klaps
Copy link
Contributor Author

@BiocondaBot please add label

@Joon-Klaps Joon-Klaps requested a review from martin-g September 30, 2024 09:49
@BiocondaBot BiocondaBot added the please review & merge set to ask for merge label Sep 30, 2024
@martin-g martin-g merged commit 57e8031 into bioconda:master Sep 30, 2024
7 checks passed
@coderabbitai coderabbitai bot mentioned this pull request Sep 30, 2024
This was referenced Oct 23, 2024
@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
please review & merge set to ask for merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants