Skip to content

[ENHANCEMENT] library install improvement #203

@burtenshaw

Description

@burtenshaw

The process of installing the lib is currently complicated because of how its modules (cli, core, and envs) are installed. I've interacted with a handful of users that find this confusing or mistake which source to install. Therefore, I would suggest that we simplify this.

Currently

To install the lib most users will do something like this:

uv pip install git+https://github.com/meta-pytorch/OpenEnv.git

This will expose the cli but not the core modules they need for env building, which most users are installing via their pyproject.toml as one of these:

"openenv-core @ git+https://github.com/meta-pytorch/OpenEnv.git@main#subdirectory=src/core",
# or
"openenv-core>=0.1.0",

Then, the user is able to define python code like this:

from openenv_core.env_server import create_app

Suggestion

I would suggest that we include the core, cli, and any future modules inside openenv and maintain a single library that can be installed like so:

uv pip install git+https://github.com/meta-pytorch/OpenEnv.git

And used within in Python code like so:

from openenv.core.env_server import create_app

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions