Skip to content
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

Add pyproject.toml for compatability with pip 25 #334

Merged
merged 2 commits into from
Feb 3, 2025

Conversation

jank324
Copy link
Member

@jank324 jank324 commented Jan 31, 2025

Description

Adds a pyproject.toml to support the modern editable build mode and configure setuptools as the build system.

Motivation and Context

  • I have raised an issue to propose this change (required for new features and bug fixes)

Closes #245.

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)

Checklist

  • I have updated the changelog accordingly (required).
  • My change requires a change to the documentation.
  • I have updated the tests accordingly (required for a bug fix or a new feature).
  • I have updated the documentation accordingly.
  • I have reformatted the code and checked that formatting passes (required).
  • I have have fixed all issues found by flake8 (required).
  • I have ensured that all pytest tests pass (required).
  • I have run pytest on a machine with a CUDA GPU and made sure all tests pass (required).
  • I have checked that the documentation builds (required).

Note: We are using a maximum length of 88 characters per line.

@jank324 jank324 linked an issue Jan 31, 2025 that may be closed by this pull request
@jank324 jank324 marked this pull request as ready for review January 31, 2025 16:18
@jank324 jank324 self-assigned this Jan 31, 2025
@jank324 jank324 added the bug Something isn't working label Jan 31, 2025
@jank324 jank324 requested a review from Hespe January 31, 2025 16:18
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just to be sure: this minimal project file is sufficient to point pip to setuptools and allow for editable installs? We do not have to move all package metadata out of setup.py into the new file?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At least this is the minimal change suggested in pypa/pip#11457.

@jank324 jank324 merged commit 8bbde40 into master Feb 3, 2025
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Deprecated Legacy Editable Installation
2 participants