Skip to content

[MRG] Package Build Script from setup.py -> pyproject toml#299

Merged
YuanmingLeee merged 2 commits into
mainfrom
install-env
Jul 6, 2025
Merged

[MRG] Package Build Script from setup.py -> pyproject toml#299
YuanmingLeee merged 2 commits into
mainfrom
install-env

Conversation

@YuanmingLeee
Copy link
Copy Markdown
Contributor

Further work on #296, migration from setup.py to pyproject.toml for a mordern package build (PEP 518, PEP 517, PEP 621)

Packaging and Configuration Updates:

  • Transition to pyproject.toml: Added a pyproject.toml file to define the project's metadata, dependencies, and build system, replacing the legacy setup.py. This modernizes the packaging approach and aligns with current Python standards.
  • Removal of setup.py: Deleted the setup.py file as its functionality is now fully covered by pyproject.toml.
  • Update in setup.cfg: Fixed a minor typo in the description_file field for consistency.
  • Add a uv lock file for uv user

Installation Documentation Improvements:

  • Enhanced Installation Instructions in README.md: Updated the installation section to provide clearer steps for installing the package from PyPI or from source, including virtual environment setup options using uv or virtualenv.

What has been done to verify that this works as intended?

Verify Installation:

Win11 (cp313) Ubuntu 22.04 (cp310)
pip
uv

How does this change affect users? Describe intentional changes to behavior and behavior that could have accidentally been affected by code changes. In other words, what are the regression risks?

Not affected

Do we need any specific form for testing your changes? If so, please attach one.

Does this change require updates to documentation? If so, please file an issue here and include the link below.

Before submitting this PR, please make sure you have:

  • confirmed all checks still pass OR confirm CI build passes.
  • verified that any code or assets from external sources are properly credited in comments and/or in
    the credit file.

Replaced `setup.py` with `pyproject.toml` to modernize the build and
package management process. Updated dependency management by
restructuring and expanding `requirements.txt`.

This change aligns with PEP 517/518 standards, improves compatibility
with modern Python packaging tools, and simplifies dependency handling.
@YuanmingLeee YuanmingLeee added the enhancement New feature or request label Jul 6, 2025
@dosubot dosubot Bot added size:L This PR changes 100-499 lines, ignoring generated files. documentation Improvements or additions to documentation labels Jul 6, 2025
@dosubot dosubot Bot added the lgtm This PR has been approved by a maintainer label Jul 6, 2025
@YuanmingLeee YuanmingLeee merged commit 6e0dbe2 into main Jul 6, 2025
3 checks passed
@YuanmingLeee YuanmingLeee deleted the install-env branch July 6, 2025 15:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request lgtm This PR has been approved by a maintainer size:L This PR changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants