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 Snk #51152

Merged
merged 6 commits into from
Oct 8, 2024
Merged

Add Snk #51152

merged 6 commits into from
Oct 8, 2024

Conversation

Wytamma
Copy link
Contributor

@Wytamma Wytamma commented Oct 4, 2024

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

Summary by CodeRabbit

  • New Features

    • Introduced a new package snk version 0.30.1 with enhanced metadata.
    • Added a new entry point for the application.
    • Included detailed requirements for both host and runtime environments.
    • Provided a dedicated section for package information, including homepage and development URL.
  • Bug Fixes

    • Added SHA256 checksum for improved package integrity verification.

Copy link
Contributor

coderabbitai bot commented Oct 4, 2024

📝 Walkthrough
📝 Walkthrough
📝 Walkthrough
📝 Walkthrough
📝 Walkthrough
📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request introduces a new meta.yaml file for the snk package, version 0.30.1. This file includes essential metadata such as the package name, version, source URL, SHA256 checksum, runtime exports, entry points, dependencies, and testing requirements. It also provides additional information about the package, including its homepage, development URL, summary, license type, and maintainers.

Changes

File Path Change Summary
recipes/snk/meta.yaml - New package declaration: name: snk, version: 0.30.1
- New source URL: url: https://pypi.io/packages/source/s/snk/snk-0.30.1.tar.gz
- New SHA256 checksum: sha256: 6bb3ed373c94ed4d9764b3ced41aecddc112c373400925f1166d52b5e5ca7c90
- New entry point: snk = snk.main:app
- New requirements for host: python >=3.8, hatchling, pip
- New requirements for run: python >=3.8, gitpython >=3.1.0,<3.2.dev0, snk-cli >=0.5.2
- New test imports: snk
- New about section: home, dev_url, summary, license, license_file
- New recipe maintainers: Wytamma

Possibly related PRs

  • recipe for pgrc #50973: The meta.yaml file for the pgrc package also introduces a new metadata file similar to the changes made in the snk package's meta.yaml.
  • Update Hsdecipher #51093: The update to the HSDecipher package's meta.yaml includes changes to the version and SHA256 checksum, which parallels the updates made in the snk 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 (1)
recipes/snk/meta.yaml (1)

51-51: Remove extra blank lines at the end of the file.

There are too many blank lines at the end of the file. Please remove the extra blank lines to improve the file's formatting.

Apply this diff to fix the issue:

-
-
🧰 Tools
🪛 yamllint

[warning] 51-51: too many blank lines

(2 > 0) (empty-lines)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between e9865fd and 15f806d.

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

[warning] 51-51: too many blank lines

(2 > 0) (empty-lines)


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

(syntax)

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

1-10: LGTM: Package and source sections are well-defined.

The package name and version are correctly defined using Jinja2 variables. The source URL is properly constructed, and the SHA256 checksum is provided for integrity verification.

🧰 Tools
🪛 yamllint

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

(syntax)


12-19: LGTM: Build section is well-configured.

The build section is properly configured:

  • The use of run_exports with pin_subpackage helps maintain compatibility.
  • The entry point for 'snk' is correctly defined.
  • The package is appropriately marked as noarch: python.
  • The build script uses the recommended method for installing the package.

31-38: LGTM: Test section is comprehensive.

The test section includes appropriate checks:

  • Import check for 'snk'
  • Pip check to ensure all dependencies are satisfied
  • Command-line help check to verify the entry point is working
  • Requirement for pip in the test environment

These tests should help ensure the package is installed and functioning correctly.


40-45: LGTM: About section is well-defined. Verify license file.

The about section provides good metadata about the package, including home and dev URLs, a summary, and license information.

Please verify that the LICENSE.txt file exists in the source package. Run the following script:

#!/bin/bash
# Description: Check if LICENSE.txt exists in the source package

# Download the source package
curl -sLO https://pypi.io/packages/source/s/snk/snk-0.30.1.tar.gz

# Extract and check for LICENSE.txt
tar -tzf snk-0.30.1.tar.gz | grep -i "license.txt"

# Clean up
rm snk-0.30.1.tar.gz

47-49: LGTM: Maintainer is specified. Verify permissions.

The recipe maintainer is listed as Wytamma.

Please verify that Wytamma has the necessary permissions to maintain this package in the Bioconda channel. You can check this by running:


21-29: LGTM: Requirements are well-defined. Verify version constraints.

The requirements section is properly structured with both host and run requirements. The Python version requirement is consistent.

Please verify that the version constraints for gitpython and snk-cli are correct and up-to-date. Run the following script to check the latest versions:

✅ Verification successful

Version constraints are up-to-date and appropriate

The current version constraints for GitPython and snk-cli in the meta.yaml file are valid and align with the latest available versions:

  • GitPython >=3.1.0,<3.2.dev0: Latest version is 3.1.43, which satisfies this constraint.
  • snk-cli >=0.5.2: Latest version is 0.5.2, which exactly matches this constraint.

No updates to the version constraints are necessary at this time.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check latest versions of gitpython and snk-cli on PyPI

echo "Latest gitpython version:"
curl -s https://pypi.org/pypi/gitpython/json | jq -r '.info.version'

echo "Latest snk-cli version:"
curl -s https://pypi.org/pypi/snk-cli/json | jq -r '.info.version'

Length of output: 229


Script:

#!/bin/bash
# Description: Check latest versions of gitpython and snk-cli on PyPI without using jq

echo "Latest gitpython version:"
curl -s https://pypi.org/pypi/gitpython/json | grep '"version":' | head -1 | sed -E 's/.*"version": "([^"]+)".*/\1/'

echo "Latest snk-cli version:"
curl -s https://pypi.org/pypi/snk-cli/json | grep '"version":' | head -1 | sed -E 's/.*"version": "([^"]+)".*/\1/'

Length of output: 164834

@Wytamma Wytamma mentioned this pull request Oct 4, 2024
@Wytamma
Copy link
Contributor Author

Wytamma commented Oct 8, 2024

@BiocondaBot please add label

@BiocondaBot BiocondaBot added the please review & merge set to ask for merge label Oct 8, 2024
@mbhall88 mbhall88 merged commit 745ffcb into bioconda:master Oct 8, 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