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

feat: include local_workspace config directory in the distribution #100

Merged
merged 1 commit into from
Jun 7, 2024

Conversation

utkarsh-dixit
Copy link
Collaborator

@utkarsh-dixit utkarsh-dixit commented Jun 5, 2024

PR Type

enhancement


Description

  • Enhanced the setup.py to include the local_tools/local_workspace/config directory in the distribution.
  • Added YAML configuration files and shell scripts to the package data.

Changes walkthrough 📝

Relevant files
Enhancement
setup.py
Include local workspace config directory in package data 

setup.py

  • Added package_data to include
    local_tools/local_workspace/config/*.yaml and
    local_tools/local_workspace/config/commands/*.sh in the distribution.
  • +6/-0     

    💡 PR-Agent usage:
    Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions


    🚀 This description was created by Ellipsis for commit d5a2747

    Summary:

    This PR adds the local_workspace/config/commands directory to the composio package distribution, including necessary YAML and shell script files.

    Key points:

    • Added local_workspace/config/commands directory to composio package distribution.
    • Modified setup.py to include YAML and shell script files from the new directory.

    Generated with ❤️ by ellipsis.dev

    Copy link

    qodo-merge-pro bot commented Jun 5, 2024

    PR Review 🔍

    ⏱️ Estimated effort to review [1-5]

    2, because the changes are localized to a single file and involve a straightforward update to the package_data configuration in setup.py. The nature of the changes (adding specific file patterns to the distribution) is not complex, and the impact is limited to how the package includes additional resources.

    🧪 Relevant tests

    No

    ⚡ Possible issues

    Possible Issue: The specified file patterns in package_data assume that the directory structure and file existence are consistent and correct. If the directories or files do not exist or are misnamed, this could lead to runtime errors or missing resources in the distribution.

    🔒 Security concerns

    No

    Copy link

    qodo-merge-pro bot commented Jun 5, 2024

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Maintainability
    Add a trailing comma after the last item in a dictionary for easier future modifications

    Add a trailing comma after the last item in the package_data dictionary to make future
    additions easier and reduce the risk of syntax errors.

    setup.py [55]

    -"local_tools/local_workspace/config/commands/*.sh"
    +"local_tools/local_workspace/config/commands/*.sh",
     
    Suggestion importance[1-10]: 7

    Why: Adding a trailing comma is a good practice for maintainability, especially in Python, as it makes future modifications to the code easier and cleaner by reducing diff noise.

    7

    Copy link
    Contributor

    @ellipsis-dev ellipsis-dev bot left a comment

    Choose a reason for hiding this comment

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

    ❌ Changes requested. Reviewed everything up to d5a2747 in 1 minute and 5 seconds

    More details
    • Looked at 19 lines of code in 2 files
    • Skipped 0 files when reviewing.
    • Skipped posting 0 drafted comments based on config settings.

    Workflow ID: wflow_8E42J2wtjCUM5xFg


    Want Ellipsis to fix these issues? Tag @ellipsis-dev in a comment. You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

    2 days left in your free trial, upgrade for $20/seat/month or contact us.

    @@ -49,4 +49,10 @@
    "pyyaml>=6.0.1",
    ],
    include_package_data=True,
    package_data={
    "composio": [
    "local_tools/local_workspace/config/*.yaml",
    Copy link
    Contributor

    Choose a reason for hiding this comment

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

    Please ensure that the paths specified in package_data accurately reflect the actual directory structure and file types in the repository. If the paths or file types are incorrect, the files will not be included in the distribution as expected.

    @shubhras01 shubhras01 merged commit 0f59ba4 into master Jun 7, 2024
    2 of 3 checks passed
    @angrybayblade angrybayblade deleted the fx-include-config-local-tools-distribution branch October 14, 2024 07:59
    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