Automatically build fishery client during wheel creation #181
Conversation
This file contains 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
This is needed to work with having namespace packages disabled. `sardine.cli.main` will still exist, but the preferred entrypoint should be `sardine.cli` or `sardine-config`.
- Adds setup.py with build subcommand to run yarn build - Excludes .svelte-kit and build artifacts from sdist - Disables include_package_data for setuptools This makes MANIFEST.in only apply to the source distribution, which is necessary to avoid including the fishery client's source. As a consequence, data files must be explicitly listed in pyproject.toml.
Actually might be a better idea to explicitly upgrade dependencies than to grab the latest compatible versions each time
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
This replaces the project build system with setuptools so setup.py can be used to build the fishery client.
When the source distribution is created, the new MANIFEST.in file will inform setuptools to exclude build artifacts like
.svelte-kit/,build/, andnode_modules/. Once the wheel is being built, setup.py will use npx to locally install yarn and then build the client. The resultingbuild/subdirectory can then be copied tobuild/lib/fishery/clientfor setuptools to bundle it into the wheel.Other changes
To avoid including the client's source code as part of the wheel, include_package_data was disabled. This means that all data files must be explicitly described in pyproject.toml with glob patterns under the
[tool.setuptools.package-data]table.To avoid un-necessarily enabling namespace packages,
sardine/cli/was re-structured to be a regular package (i.e. having an__init__.py). The originalsardine.cli.mainentrypoint can still be used, but the new and preferred entrypoint is nowsardine.cli.