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

exclude metadata.json file #357

Merged
merged 4 commits into from
Oct 16, 2024

Conversation

AnnMarieW
Copy link
Collaborator

@AnnMarieW AnnMarieW commented Oct 15, 2024

Based on this discussion at Plotly, it's OK to exclude the metadata.json file which will reduce the package size significantly.

We started be minifying the metadata.json file in #347 which reduced the file size from 5MB to 3MB. This PR excludes the file.

Also included some new files that were added when setting up testing and the PyCafe hosting in MANIFEST.in. This ensures the tar.gz file can be installed without errors.

I tested this by running:

  • npm run build
  • npm run dist

installed the tarball in a new venv
ran a sample app - everything worked fine :tada

MANIFEST.in Outdated
@@ -4,3 +4,6 @@ prune tests
include README.md
include LICENSE
include package.json
include requires-install.txt
include requires-dev.txt
exclude dash_mantine_components/metadata.json
Copy link
Collaborator

Choose a reason for hiding this comment

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

This works, but it's a little funny to include *.json above and then exclude this one. The result of those two together is just to include dash_mantine_components/package-info.json so it would be cleaner to just include that file by itself.

While we're at it, it's also redundant (but common across most dash component suites) that we include both package.json and dash_mantine_components/package-info.json since these are identical (package.json is copied to dash_mantine_components/package-info.json during build). The former is referenced in setup.py to pull information into the pypi record, the latter in dash_mantine_components/__init__.py to get the package name and version, and I believe that's it. This file isn't very big, but we should be able to remove package.json entirely if we point setup.py to the other one.

Copy link
Collaborator

@alexcjohnson alexcjohnson left a comment

Choose a reason for hiding this comment

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

💃 LGTM - one nonblocking comment.

@AnnMarieW AnnMarieW merged commit b5987ec into snehilvj:master Oct 16, 2024
1 check passed
@AnnMarieW AnnMarieW mentioned this pull request Nov 7, 2024
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.

2 participants