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.

Sign up for GitHub

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

Jump to bottom

Add check_requires() function and update installation docs #56

Merged
merged 8 commits into from
Oct 25, 2024
Merged

Add check_requires() function and update installation docs #56

merged 8 commits into from
Oct 25, 2024

Conversation

lazappi
Copy link
Collaborator

@lazappi lazappi commented Oct 24, 2024

Added a function that checks if suggested packages are installed and gives a nice error with installation instructions if not.

Updated installation docs with instructions for installing suggested dependencies and information on what they are used for.

Fixes #46
Fixes #47

@lazappi lazappi requested a review from rcannood October 24, 2024 08:33
rcannood
rcannood requested changes Oct 25, 2024
View reviewed changes
Copy link
Collaborator

@rcannood rcannood left a comment

Choose a reason for hiding this comment

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

Nice, great work!

  • Could you add an entry to the changelog?
  • Could you add a small unit test to check that check_requires("foobar") throws an error but check_requires("laminr") doesn't?

@lazappi
Merge remote-tracking branch 'origin/main' into issues-46-47/check-su…
2c497ce 
…ggests

* origin/main:
  Remove link tables from print output (#55)
  Add progress bar (#58)
  Add get_records() to API and df() to Registry (#54)
@rcannood
Copy link
Collaborator

LGTM!

@rcannood rcannood merged commit dcacbb6 into main Oct 25, 2024
6 of 7 checks passed
@rcannood rcannood deleted the issues-46-47/check-suggests branch October 25, 2024 17:50
lazappi added a commit that referenced this pull request Oct 31, 2024
@lazappi
Merge remote-tracking branch 'origin/main' into issue-49/adjust-print…
c392824 
…-colours

* origin/main:
  Add Records container class (#59)
  Refactor documentation (#67)
  Fix macOS runner (#66)
  Add check_requires() function and update installation docs (#56)
  Remove link tables from print output (#55)
  Add progress bar (#58)
  Add get_records() to API and df() to Registry (#54)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rcannood rcannood rcannood approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add checks for suggested packages Add suggested dependencies to setup documentation
2 participants
@lazappi @rcannood