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

fix: setup.py #43

Merged
merged 1 commit into from
Nov 20, 2024
Merged

fix: setup.py #43

merged 1 commit into from
Nov 20, 2024

Conversation

JarbasAl
Copy link
Member

@JarbasAl JarbasAl commented Nov 20, 2024

images not included in pypi package

Summary by CodeRabbit

  • Chores
    • Updated resource directories in the package configuration, enhancing the search for resource files.

images not included in pypi package
@JarbasAl JarbasAl requested a review from mikejgray November 20, 2024 11:28
Copy link
Contributor

coderabbitai bot commented Nov 20, 2024

Walkthrough

The changes in this pull request focus on the setup.py file of a Python package, specifically modifying the find_resource_files function. The update involves altering the resource_base_dirs tuple by removing the directories "intents" and "dialog" and adding the "gui" directory. This adjustment impacts the search paths for resource files included in the package, but no other significant changes to logic or error handling are present.

Changes

File Change Summary
setup.py Updated find_resource_files function by removing "intents" and "dialog" directories and adding "gui" directory.

Possibly related PRs

  • modernize #38: The changes in setup.py regarding the find_resource_files function and the addition of the "gui" directory are related to the updates in MANIFEST.in, which now includes the gui directory for packaging, ensuring that the resources are correctly included in the package distribution.

Suggested reviewers

  • mikejgray

🐇 In a world of code and files,
I hop and skip through endless miles.
With "gui" now in the search, hooray!
Resources found, come out to play!
Intents and dialogs, take a rest,
For now, the "gui" is simply the best! 🌟


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.

@github-actions github-actions bot added the fix label Nov 20, 2024
@JarbasAl JarbasAl mentioned this pull request Nov 20, 2024
@github-actions github-actions bot added fix and removed fix labels Nov 20, 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)
setup.py (2)

Line range hint 51-59: Consider enhancing resource file discovery

While the current implementation will fix the image packaging issue, here are some suggested improvements:

  1. Add explicit file patterns for images (*.png, *.jpg, etc.)
  2. Add error handling for non-existent resource directories
  3. Consider logging when resource directories are found/not found

Here's a suggested enhancement:

 def find_resource_files():
-    resource_base_dirs = ("locale", "gui", "sounds")
-    package_data = ["*.json"]
-    for res in resource_base_dirs:
-        if path.isdir(path.join(BASE_PATH, res)):
-            for directory, _, files in walk(path.join(BASE_PATH, res)):
-                if files:
-                    package_data.append(path.join(directory.replace(BASE_PATH, "").lstrip("/"), "*"))
-    return package_data
+    resource_base_dirs = ("locale", "gui", "sounds")
+    package_data = ["*.json"]
+    image_patterns = ["*.png", "*.jpg", "*.jpeg", "*.gif", "*.svg"]
+    
+    for res in resource_base_dirs:
+        res_path = path.join(BASE_PATH, res)
+        if not path.isdir(res_path):
+            print(f"Warning: Resource directory '{res}' not found")
+            continue
+            
+        print(f"Including resources from '{res}' directory")
+        for directory, _, files in walk(res_path):
+            if files:
+                rel_path = path.join(directory.replace(BASE_PATH, "").lstrip("/"))
+                package_data.append(path.join(rel_path, "*"))
+                # Add specific patterns for gui directory
+                if res == "gui":
+                    for pattern in image_patterns:
+                        package_data.append(path.join(rel_path, pattern))
+    
+    return package_data

Line range hint 51-59: Consider adding package manifest

To ensure consistent packaging across different environments, consider adding a MANIFEST.in file to explicitly declare resource files.

Example MANIFEST.in content:

include README.md
include requirements.txt
include requirements-dev.txt
recursive-include gui *
recursive-include locale *
recursive-include sounds *
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 212cdb6 and a9fd2bd.

📒 Files selected for processing (1)
  • setup.py (1 hunks)
🔇 Additional comments (1)
setup.py (1)

51-51: Verify removal of 'intents' and 'dialog' directories

The change adds support for GUI resources (including images) but removes 'intents' and 'dialog' directories. Please confirm that these directories are no longer needed in the package.

@JarbasAl JarbasAl merged commit 2b8171a into dev Nov 20, 2024
14 checks passed
@JarbasAl JarbasAl deleted the JarbasAl-patch-1 branch November 20, 2024 13:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants