-
Notifications
You must be signed in to change notification settings - Fork 116
[ENHANCEMENT] Restructure package for simplified installation #225
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: release
Are you sure you want to change the base?
Conversation
rycerzes
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! Having a deprecation warning of sorts would be beneficial
Also I think the dependency grouping in the updated pyproject.toml needs clarification.
Right now, core contains all the server dependencies (FastAPI, Pydantic, Uvicorn, Requests), but it’s declared under optional-dependencies. That makes it seem like core is required for normal usage, yet it's not installed by default.
This PR solves this issue. In short, that the package is not straightforward or conventional to install or import.
DX changes
The PR has a significant amount of new lines, made mostly out of grepping and moving. The fundamental change is this:
User will install like this:
User can use the core library in their envs like so:
And install in the env tomls with
openenv[core],openenv, orgit+https://github.com/meta-pytorch/OpenEnv.git, without a subdirectory reference.Implementation
The Changes to implement this are:
openenv_coreis now a shim.openenv.core