Move report deps to optional extras & update README#19
Merged
Conversation
Move heavy report dependencies (plotly ~76MB, pandas, jinja2) from core dependencies to an optional [report] extra in pyproject.toml. This reduces base install size from ~110MB to ~15MB. Users who need HTML reports can install with: pip install virusxcheck[report] - Remove plotly from core dependencies and requirements.txt - Add [report] optional extra with plotly, pandas, jinja2 - Add graceful ImportError in html_reporter.py with install instructions - Update install message in virusxcheck.py - Document optional report install in README.md Closes #18 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- Add GitHub badges (version, Python versions, license) - Add 'From PyPI' as primary install method with pip install virusxcheck - Add 'From Source' section with git clone workflow - Add Quick Start section for fast onboarding - Update all usage examples to use virusxcheck CLI command - Add Contributing, Changelog, Security, and License sections Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
lewiswigmore
force-pushed
the
fix/optional-report-deps
branch
from
800774c to
e64ed5a
Compare
lewiswigmore
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Addresses #18 — slow pip install caused by plotly (~76 MB) being a core dependency.
Changes
Dependency optimisation:
[report]extrapip install virusxcheck[report]ImportErrorinhtml_reporter.pywith clear install instructionsvirusxcheck.pyREADME enhancements for PyPI readiness:
pip install virusxcheckas primary install methodvirusxcheckCLI commandTesting
All 81 existing tests pass. Core import works without report dependencies.
Closes #18