Skip to content

Document how to install the reflex-xy adapter from a clean environment #78

Description

@amsraman

Problem

python/reflex-xy/README.md contains useful configuration and usage examples, but it never states how users should install the adapter.

A user starting with a normal Reflex project cannot tell whether to use pip install reflex-xy, an extra on the core xy package, a GitHub/path dependency, or an editable monorepo install.

This is especially confusing because the core README describes the Reflex integration as experimental and kept outside the core package dependency graph, while the adapter lives in a nested independently packaged project.

Reproduction

  1. Create a clean Reflex app.
  2. Follow the adapter README's rxconfig.py and application examples.
  3. Try to determine the supported installation command from the README.

There is no install or development-install section, so import reflex_xy is not reproducible from the documented steps alone.

Expected

The adapter README should start with a short installation section that states:

  • whether reflex-xy is currently published;
  • the supported install command if published;
  • the exact monorepo/path install command if it is currently source-only;
  • compatible reflex and xy version constraints; and
  • any native-core prerequisite inherited from xy.

A minimal clean-environment smoke command would also help validate the instructions.

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