8000 (v3.6.1) pip install fix with pyproject.toml by AlejandroCN7 · Pull Request #449 · ugr-sail/sinergym · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

(v3.6.1) pip install fix with pyproject.toml #449

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

Merged
merged 7 commits into from
Sep 27, 2024
Merged

(v3.6.1) pip install fix with pyproject.toml #449

merged 7 commits into from
Sep 27, 2024

Conversation

AlejandroCN7
Copy link
Member

Description

Poetry and pyproject.toml are compatible with pip usage. However, a definition error previously prevented the installation of extras containing essential utilities for running experiments, should users wish to use them.

This update ensures that development libraries are installed natively when running poetry install. Nevertheless, some of them are marked as optional in the main dependencies so they can be used through extras.

For more information on how container and workflow installations have been updated, the documentation in the installation section has been revised with much greater detail.

The list of extras is now separate from the development dependency groups, so the pip-installable extras are limited to DRL utilities and for running tests.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation (update in the documentation)
  • Improvement (of an existing feature)
  • Others

Checklist:

  • I've read the CONTRIBUTION guide (required)
  • My change requires a change to the documentation.
  • I have updated the tests.
  • I have updated the documentation accordingly.
  • I have reformatted the code using autopep8 second level aggressive.
  • I have reformatted the code using isort.
  • I have ensured cd docs && make spelling && make html pass (required if documentation has been updated.)
  • I have ensured pytest tests/ -vv pass. (required).
  • I have ensured pytype -d import-error sinergym/ pass. (required)

Changelog:

  • pyproject.toml fix: pip works with extras.
  • Dockerfile: Dockerfile for experiment and develop fix for new poetry definition.
  • pyproject.toml include test dependencies as extras for pip.
  • Documentation fixed with the new form of installation.
  • Workflows: Poetry installation fixes.

@AlejandroCN7 AlejandroCN7 merged commit e676657 into main Sep 27, 2024
6 checks passed
@AlejandroCN7 AlejandroCN7 deleted the bug/v3.6.1 branch September 27, 2024 11:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant
0