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

Revert "Include SkipSpecies cosine similarities in package files" #262

Merged
merged 2 commits into from
Jun 4, 2024

Conversation

AntObi
Copy link
Collaborator

@AntObi AntObi commented Jun 4, 2024

Reverts #261

Summary by CodeRabbit

  • Chores
    • Updated packaging configuration to include specific file types in the package data for better control over included files.

Copy link
Contributor

coderabbitai bot commented Jun 4, 2024

Walkthrough

The recent changes involve updating the MANIFEST.in and setup.py files to refine the inclusion of package data. The MANIFEST.in file no longer includes all files recursively from the smact/data directory. Instead, the setup.py file has been updated to explicitly specify the types of files to include within the package data, enhancing control and precision over the packaging process.

Changes

File Change Summary
MANIFEST.in Removed the line recursive-include smact/data *, stopping the recursive inclusion of all files in smact/data.
setup.py Modified to specify file types to include in package_data, enhancing precision in package data inclusion.

Poem

In the land of code, where changes flow,
MANIFEST trimmed, a lighter show.
setup.py, with careful hand,
Lists each file, so neat and grand.
Packages now, so clear and bright,
CodeRabbit cheers, with pure delight! 🐇✨


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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

codecov bot commented Jun 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.50%. Comparing base (32413b0) to head (44cd2a1).
Report is 117 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop     #262   +/-   ##
========================================
  Coverage    74.50%   74.50%           
========================================
  Files           24       24           
  Lines         2083     2083           
========================================
  Hits          1552     1552           
  Misses         531      531           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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)
setup.py (1)

Line range hint 14-14: Remove unused imports to clean up the code.

- import unittest
- from setuptools import Extension

Also applies to: 16-16

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 988bb07 and 44cd2a1.

Files selected for processing (3)
  • MANIFEST.in (1 hunks)
  • examples/Dopant_Prediction/doper_example.ipynb (6 hunks)
  • setup.py (1 hunks)
Files not summarized due to errors (1)
  • examples/Dopant_Prediction/doper_example.ipynb: Error: Message exceeds token limit
Files skipped from review due to trivial changes (1)
  • MANIFEST.in
Additional context used
Ruff
setup.py

14-14: unittest imported but unused (F401)


16-16: setuptools.Extension imported but unused (F401)

Additional comments not posted (3)
setup.py (1)

39-48: The changes to package_data provide a more controlled inclusion of files in the package. Ensure all necessary file types are listed.

Verification successful

The smact/data directory contains files with extensions .csv, .txt, .data, .xlsx, and .json, which are all included in the package_data dictionary. No additional file types are necessary.

Scripts executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify that all necessary file types are included in the package data.

# Test: List all file types in the smact/data directory. Expect: Only listed types should be present.
fd --type file --extension txt,csv,data,xlsx,json 'smact/data'

Length of output: 408



Script:

#!/bin/bash
# Description: Verify that all necessary file types are included in the package data.

# Test: List all file types in the smact/data directory. Expect: Only listed types should be present.
fd --type file --full-path 'smact/data' --extension txt,csv,data,xlsx,json

Length of output: 74



Script:

#!/bin/bash
# Description: List all files in the smact/data directory to verify its contents.

# Test: List all files in the smact/data directory.
fd --type file --full-path 'smact/data'

Length of output: 742

examples/Dopant_Prediction/doper_example.ipynb (2)

36-36: Ensure the installation command is executed only in the Colab environment. This is a good practice to prevent unnecessary installations.

Also applies to: 40-40, 43-43


47-50: Verify the execution of dopant prediction functions to ensure they work as expected.

Also applies to: 78-81, 103-109, 125-128, 149-154, 159-166

@AntObi AntObi merged commit 301c332 into develop Jun 4, 2024
16 checks passed
@AntObi AntObi deleted the revert-261-species_updates branch June 4, 2024 12:47
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.

1 participant