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

build: use soft package dependencies #105

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Conversation

jooyoungseo
Copy link
Member

@jooyoungseo jooyoungseo commented Aug 30, 2024

This pull request addresses issue #94 by implementing soft package dependencies. Instead of forcing users to install all package dependencies, this change allows for optional installation of certain packages based on the features the user wants to use. The following packages are now marked as optional:

  • jupyter
  • shiny
  • numpy
  • matplotlib
  • seaborn

Users can choose to install these packages only if they need the corresponding features.

After this change

# Install all the required and soft dependencies (recommended for beginners)
pip install maidr[all]
# Install the minimal and required dependencies only (for advanced users who maintain their own dependencies)
pip install maidr
# Install required dependencies + optional data science packages (currently, `jupyter` only, but we may be able to move `numpy`, `matplotlib`, and `seaborn` down here)
pip install maidr[datascience]
# Install required dependencies + dashboard packages (currently, `shiny` only, but will be able to add more packages later, such as `streamlit` as we support them)
pip install maidr[dashboard]

Closes #94

@jooyoungseo jooyoungseo marked this pull request as ready for review August 30, 2024 14:50
@jooyoungseo jooyoungseo requested a review from SaaiVenkat August 30, 2024 14:50
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.

build: use soft package dependencies
1 participant