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 newick #51325

Closed
wants to merge 2 commits into from
Closed

Add newick #51325

wants to merge 2 commits into from

Conversation

visze
Copy link
Contributor

@visze visze commented Oct 11, 2024

python package to read and write the Newick format.

This package will be used for seqspec


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

📝 Walkthrough
📝 Walkthrough

Walkthrough

This pull request introduces a new file, meta.yaml, for the newick package version 1.9.0. The file outlines the package's configuration, including its name, version, and source URL for downloading from PyPI, along with a SHA256 checksum for integrity verification. The build section specifies that the package is architecture-independent and provides the installation script using pip without dependencies or build isolation. The requirements section details the necessary dependencies for both host and runtime environments, mandating Python version 3.7 or higher, setuptools, and pip. The test section includes import checks for the newick module and a command to verify installed packages via pip. Additionally, the about section offers metadata such as the project homepage, a brief summary of its functionality, the license type, and a reference to the license file. The file also designates maintainers for the recipe.

Possibly related PRs

  • Add Snk #51152: The addition of the snk package involves creating a new meta.yaml file, similar to the creation of the meta.yaml file for the newick package in the main PR. Both PRs define package metadata, source URLs, SHA256 checksums, and dependencies.

Suggested labels

please review & merge

Suggested reviewers

  • mbhall88

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 (2)
recipes/newick/meta.yaml (2)

8-10: LGTM: Source information is correctly specified.

The source URL and SHA256 checksum are properly defined. The use of a checksum is a good security practice for ensuring package integrity.

Consider adding a comment with the direct URL for easier manual verification:

source:
  url: https://pypi.org/packages/source/{{ name[0] }}/{{ name }}/newick-{{ version }}.tar.gz
  # https://pypi.org/packages/source/n/newick/newick-1.9.0.tar.gz
  sha256: 9f81be96ec86aefca74d920fc0d6962d89a3156547003ca6915c2e6e31ad3ddf

25-31: LGTM: Test section is well-defined, consider adding a functional test.

The test section includes appropriate checks:

  • Import test for the newick module.
  • pip check command to verify package compatibility.
  • Correct inclusion of pip in test requirements.

Consider adding a simple functional test to ensure basic functionality. For example:

test:
  imports:
    - newick
  commands:
    - pip check
    - python -c "import newick; assert newick.loads('(A,B)C;'), 'Failed to parse a simple Newick tree'"
  requires:
    - pip
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 8c12e52 and 36e8e95.

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

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

(syntax)

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

1-6: LGTM: Package metadata is correctly defined.

The package name and version are properly set using Jinja2 templating, which is a good practice for maintaining consistency across the recipe.

🧰 Tools
🪛 yamllint

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

(syntax)


12-15: LGTM: Build configuration is well-defined.

The build section is correctly configured:

  • noarch: python is appropriate for a pure Python package.
  • The installation script follows best practices by using --no-deps and --no-build-isolation.
  • The build number is correctly set to 0 for an initial release.

33-37: LGTM: About section provides comprehensive metadata.

The about section is well-defined:

  • The home URL correctly points to the GitHub repository.
  • The summary concisely describes the package's functionality.
  • License information is properly specified, including the license type and file reference.

39-41: LGTM: Recipe maintainer is correctly specified.

The recipe maintainer is properly set to "visze", which matches the PR submitter mentioned in the PR objectives.


1-41: Overall assessment: The meta.yaml file is well-structured and follows Conda packaging best practices.

The recipe for the newick package is correctly defined, including all necessary sections such as package metadata, source, build instructions, requirements, tests, and about information. The use of Jinja2 templating and the inclusion of a SHA256 checksum are good practices.

A few minor suggestions for improvement:

  1. Add a comment with the direct PyPI URL for easier manual verification.
  2. Verify if there are any additional run dependencies for the newick package.
  3. Consider adding a simple functional test to ensure basic functionality.

These suggestions are optional and do not affect the overall quality of the recipe. Great job on creating this Conda recipe!

🧰 Tools
🪛 yamllint

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

(syntax)


17-23: LGTM: Requirements are properly specified, but verify run dependencies.

The host and run requirements are correctly defined. However, it's worth verifying if there are any additional run dependencies for the newick package.

Please run the following script to check for any potential missing run requirements:

@visze
Copy link
Contributor Author

visze commented Oct 11, 2024

@BiocondaBot please add label

@BiocondaBot BiocondaBot added the please review & merge set to ask for merge label Oct 11, 2024
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 (2)
recipes/newick/meta.yaml (2)

8-10: LGTM: Source definition is correct.

The source URL and SHA256 checksum are properly defined. The use of Jinja2 templating in the URL is good for maintainability.

Consider adding a comment with the actual URL for easier reading and debugging. For example:

source:
  url: https://pypi.org/packages/source/{{ name[0] }}/{{ name }}/newick-{{ version }}.tar.gz
  # https://pypi.org/packages/source/n/newick/newick-1.9.0.tar.gz
  sha256: 9f81be96ec86aefca74d920fc0d6962d89a3156547003ca6915c2e6e31ad3ddf

27-33: LGTM: Test configuration is good, but consider adding a functional test.

The test section is well-defined:

  • The import check for the newick module is essential.
  • The pip check command is a good practice to ensure all dependencies are correctly installed.
  • Including pip as a test requirement is correct for running the pip check command.

Consider adding a simple functional test to ensure the package works as expected. For example:

test:
  imports:
    - newick
  commands:
    - pip check
    - python -c "import newick; tree = newick.loads('(A,B,(C,D)E)F;'); assert tree.name == 'F'"
  requires:
    - pip

This additional test creates a simple tree and checks if it's parsed correctly.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 36e8e95 and 4e4c229.

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

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

(syntax)

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

1-6: LGTM: Package and version definition looks good.

The use of Jinja2 templating for the package name and version is a good practice for maintainability. The package name is correctly lowercased in the package section.

🧰 Tools
🪛 yamllint

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

(syntax)


12-17: LGTM: Build configuration is well-defined.

The build section is correctly configured:

  • The noarch: python setting is appropriate for a pure Python package.
  • The run_exports section is correctly implemented as per the PR objectives, ensuring compatibility with downstream recipes.
  • The build script follows the recommended approach for pip installation without dependencies or build isolation.
  • The build number is correctly set to 0 for a new package.

35-39: LGTM: About section is complete and accurate.

The about section contains all the required metadata:

  • The home URL points to the correct GitHub repository.
  • The summary is concise and accurately describes the package's functionality.
  • The license is correctly specified as Apache-2.0, matching the information in the PR objectives.
  • The license file is correctly referenced.

41-43: LGTM: Maintainer information is correct.

The extra section correctly lists 'visze' as the recipe maintainer, which matches the PR submitter mentioned in the PR objectives.


1-1: Note: Ignore the 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 templating syntax, which is commonly used and valid in Bioconda recipes. The YAML file is correctly formatted and follows the Bioconda recipe guidelines.

🧰 Tools
🪛 yamllint

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

(syntax)


19-25: LGTM: Requirements are defined, but verify run dependencies.

The requirements section is well-structured:

  • Python version requirement (>=3.7) is consistent between host and run environments.
  • Host requirements appropriately include setuptools and pip.

Please verify if there are any additional run requirements for the newick package. You can check this by running the following script:

If any dependencies are found, please update the run requirements accordingly.

✅ Verification successful

Verified: Run dependencies are correctly defined.

The requirements section is comprehensive, and no additional run dependencies were found for the newick package based on the verification.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for any dependencies in setup.py or pyproject.toml

# Test: Search for install_requires in setup.py
echo "Checking setup.py for dependencies:"
fd -t f setup.py | xargs rg "install_requires"

# Test: Search for dependencies in pyproject.toml
echo "Checking pyproject.toml for dependencies:"
fd -t f pyproject.toml | xargs rg "dependencies"

# Test: Check if there's a requirements.txt file
echo "Checking for requirements.txt:"
fd -t f requirements.txt

Length of output: 1332

@visze visze mentioned this pull request Oct 11, 2024
@@ -0,0 +1,43 @@
{% set name = "newick" %}
Copy link
Member

Choose a reason for hiding this comment

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

should we maybe also call this package python-newick?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

OH! it is already there and it is called python-newick. thank you! Will clos ethe PR

@visze
Copy link
Contributor Author

visze commented Oct 14, 2024

python is already there. called python-newick

@visze visze closed this Oct 14, 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