Migrate2pyproject.toml - #104
Open
psolmor wants to merge 6 commits into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
This PR migrates the project’s packaging configuration from setup.py/requirements.txt to a modern pyproject.toml (PEP 621), and updates documentation/CI to install doc/test dependencies via extras.
Changes:
- Removed legacy
setup.pyandrequirements.txt, introducingpyproject.tomlwith core dependencies plustest/docsextras. - Updated docs and GitHub Actions / Read the Docs configuration to install
.[docs](and documented.[test]). - Added an Unreleased changelog entry and exposed
opal.__version__via package metadata.
Reviewed changes
Copilot reviewed 7 out of 9 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
setup.py |
Removed legacy setuptools setup metadata. |
requirements.txt |
Removed ad hoc dependency list (now covered by pyproject.toml). |
pyproject.toml |
Added project metadata, dependencies, and optional extras for docs/tests. |
opal/__init__.py |
Added runtime __version__ lookup via importlib.metadata. |
doc/source/setup.rst |
Updated installation instructions to use .[test] / .[docs] extras. |
CHANGELOG.md |
Added Unreleased entry describing the packaging migration. |
.readthedocs.yml |
Switched RTD install to pip with the docs extra and updated build image/tooling. |
.gitignore |
Added ignores for build artifacts and environments. |
.github/workflows/main.yml |
Updated docs workflow to install dependencies via .[docs]. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| [tool.setuptools] | ||
| include-package-data = true | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Migrate packaging metadata to pyproject.toml and define optional extras for test and documentation workflows. This updates the repository to use modern Python packaging, removes the need for ad hoc dependency installation in CI and docs, and keeps the public setup instructions aligned with the project metadata.
The documentation and GitHub Actions workflow have been updated to install dependencies via extras instead of manually listing them. The changelog now includes an Unreleased entry describing the packaging migration.
The installation has been verified in a clean environment, and functionality was checked by running the existing smoke tests (
python tests/smoke_notebooks.py).Installation options:
pip install .pip install .[test]pip install .[docs]