Skip to content

Contributor quick start does not build the required native core #77

Description

@amsraman

Problem

The documented contributor quick start in CONTRIBUTING.md is:

uv venv
uv pip install -e ".[dev]"
make check

On a clean checkout on macOS Apple Silicon, the editable install completes, but it does not create libxy_core.dylib. The following test/check step then fails during collection because importing xy.kernels cannot find the native core.

Reproduction

git clone https://github.com/reflex-dev/xy.git
cd xy
uv venv
uv pip install -e ".[dev]"
make test

Representative error:

ImportError: xy native core not found (looked for libxy_core.dylib in
python/xy/_native_lib/, target/release/, and target/debug/)

Expected

Following the documented quick start should leave the checkout ready to run the documented fast gate, or the guide should include the required native build step before make check.

Suggested fix

  • Make make setup build the native core and use that command in the quick start; or
  • add an explicit native-build command to the quick start; or
  • make make check detect the missing library and build it or print concise remediation before running pytest.

Environment

  • macOS Apple Silicon
  • clean temporary virtual environment
  • Python 3.14.5
  • current repository checkout

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions