Adopt dynamic versioning and pyproject.toml for package setup #19
Conversation
This file contains 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
This commit transitions the package setup process from a traditional setup.py-based approach to a modern pyproject.toml configuration. It introduces dynamic versioning to automatically determine the package version from uxsim/__init__.py, eliminating the need for direct imports in the setup phase. This change resolves the import issue encountered during installation and aligns with best practices for Python packaging. - Added pyproject.toml with build system requirements, project metadata, dependencies, and dynamic versioning configuration. - Removed direct import of uxsim in setup.py to avoid installation errors. - Ensured uxsim/__init__.py defines __version__ for dynamic versioning compatibility.
This commit addresses an issue encountered during the package build process where setuptools identified multiple top-level packages in a flat-layout project structure. To resolve this, the commit explicitly defines package discovery rules in pyproject.toml, using the `find` directive. The configuration now includes only the intended `uxsim` package (and its subpackages) while excluding other directories such as `dat` and `demos_and_examples` from the packaging process. This change ensures that setuptools correctly identifies and includes only the relevant Python package components in the distribution, preventing the accidental inclusion of unrelated directories.
Update the installation instructions to include how to install git branches.
|
Thanks for this, but sorry, I am not familiar with modern packaging practice. Please give me some time to update my knowledge. After that I will do it by my own. |
|
Okay, that sounds smart! This is a good read: https://packaging.python.org/en/latest/guides/writing-pyproject-toml/ |
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.
This commit transitions the package setup process from a traditional
setup.py-based approach to a modernpyproject.tomlconfiguration. It introduces dynamic versioning to automatically determine the package version fromuxsim/__init__.py, eliminating the need for direct imports in the setup phase. This change resolves the import issue encountered during installation and aligns with best practices for Python packaging.uxsim/__init__.pydefines__version__for dynamic versioning compatibility.This also fixes local installations failing and adds instruction to the Readme how to install from a git branch.