-
Notifications
You must be signed in to change notification settings - Fork 1
Description
Description
When following the development installation instructions in the README, users encounter an error when trying to install the package in editable mode with pip install -e .:
text
ERROR: File "setup.py" not found. Directory cannot be installed in editable mode: /path/to/python-sdk (A "pyproject.toml" file was found, but editable mode currently requires a setup.py based build.)
This creates a barrier for developers trying to contribute to or work with the SDK in a development environment.
Steps to Reproduce
Clone the repository
Create and activate a virtual environment: python3 -m venv venv && source venv/bin/activate
Attempt to install in editable mode: pip install -e .
Observe the error about missing setup.py
Expected Behavior
The package should install successfully in editable mode using the modern pyproject.toml configuration, allowing developers to make changes to the source code that are immediately reflected in their environment.
Actual Behavior
Installation fails with an error indicating that editable mode requires a setup.py file, despite the presence of pyproject.toml.
Proposed Solutions
Add setup.py back (temporary solution):
python
from setuptools import setup, find_packages
setup(
name="fixpoint_sdk",
packages=find_packages(where="src"),
package_dir={"": "src"},
)
Update pip and use modern build backend (recommended):
Ensure users have pip >= 21.3
Configure pyproject.toml to properly support editable installs with a build backend like setuptools or hatchling
Update README instructions to include:
bash
Ensure modern pip version
pip install --upgrade pip>=21.3
Then install in editable mode
pip install -e .
Environment
Python version: 3.8+
pip version: <21.3 (likely causing the issue)
OS: Any
Additional Context
The repository uses a modern Python packaging structure with pyproject.toml but appears to have dependency on older pip behavior. The workaround mentioned in the README (upgrading pip) should be the primary solution, but the underlying packaging configuration may need adjustment to fully support editable installs with pyproject.toml.
This issue affects developer onboarding and contribution workflow, as editable mode is essential for efficient development and testing.