Skip to content

Conversation

@MFA-X-AI
Copy link
Member

@MFA-X-AI MFA-X-AI commented May 22, 2023

Description

This PR updates the default way xircuits-components fetches the components from pulling each file recursively to simply copying it from the site-packages (this behavior already exists if you run xircuits without xai_components present in your working dir, but it now the default for xircuits-components as well).

If users would still want to fetch the components online or from a specific online branch, they can add the --download tag. This PR also updates several error messages in this process.

References

#152

Pull Request Type

  • Xircuits Core (Jupyterlab Related changes)
  • Xircuits Canvas (Custom RD Related changes)
  • Xircuits Component Library
  • Xircuits Project Template
  • Testing Automation
  • Documentation
  • Others (Please Specify)

Type of Change

  • New feature (non-breaking change which adds functionality)
  • Bug fix (non-breaking change which fixes an issue)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Tests

Install Xircuits from this PR's wheel and verify that:

  1. when you run xircuits-components, it copies it from site-packages.
  2. when you run xircuits-components --download it will download the components from an online source. Verify also that the error messages such as, unable to retrieve xai_components/xai_submodulename cannot be retrieved, skipping... no longer exist in this command.
  3. Bonus - if you call xircuits-components --download multiple times in an hour, you will be greeted with the pyGithub error message.

Tested on?

  • Windows
  • Linux Ubuntu
  • Centos
  • Mac
  • Others (State here -> xxx )

@MFA-X-AI MFA-X-AI changed the title make xircuits-components copy instead of fetch by default, add more e… 🐛 Update xircuits-components to fetch from local May 22, 2023
Copy link
Member

@mansouralawi mansouralawi left a comment

Choose a reason for hiding this comment

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

Thank you for this pull request. Your work to make the components accessible locally and remotely has been effectively implemented. I'm pleased to confirm that all tests have passed.

@mansouralawi mansouralawi merged commit d0c551e into master May 31, 2023
@mansouralawi mansouralawi deleted the fahreza/update-component-pull branch May 31, 2023 09:11
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.

3 participants