fix: allow pip install when not the repo root #3
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.
Allow pip install when package is not at repo root
Problem
Currently, PufferLib can only be installed properly when it's located at the root of a repository. This makes it difficult to vendor the library as a subdirectory (e.g.,
deps/pufferlib) or use it as a submodule, especially with editable installs.Solution
This PR makes PufferLib installable regardless of its location in the directory structure by:
find_packages()topufferlibexplicitlypackage_dir={"": "pufferlib"}to specify the package rootpyproject.tomlfields to support modern build tools and PEP 660Benefits
-einstalls work correctly regardless of package locationThese changes are minimal and focused solely on improving the installation process without affecting functionality or existing workflows.