Maratyszcza / Opcodes

Database of CPU Opcodes
Other
241 stars 42 forks source link

Proposal: Adopt pyproject.toml for Project Improvement #52

Open iconFehu opened 9 months ago

iconFehu commented 9 months ago

Description:

Issue Description:

The current configuration file format in use shows signs of being outdated, potentially hindering the project's adaptability and distancing it from modern Python development practices. To address this, I propose migrating to pyproject.toml, a widely accepted standard for Python projects introduced by PEP 518 and implemented in Python 3.7. This move aims to ensure our project stays current and well-supported.

Advantages:

Historical Background:

The introduction of the pyproject.toml file was realized through PEP 518, titled "Specifying Minimum Build System Requirements for Python Projects." This PEP was accepted and implemented in Python 3.7, providing a standardized way to specify build system requirements for Python projects, replacing the previous use of setup.py or setup.cfg files.

Proposed Steps:

  1. Configuration Migration: Swiftly transition the existing configuration to pyproject.toml to align with best practices in the Python community.

  2. Documentation Update: Promptly update project documentation to guide users and contributors through the new pyproject.toml configuration structure.

  3. Testing and Validation: Rigorously test the project's build and dependency management under the new configuration to guarantee a smooth transition without compromising project stability.

Additional Context:

I am willing to actively contribute to this migration process and submit a Pull Request promptly.

Thank you for your attention to this matter.

Maratyszcza commented 8 months ago

SG, you're welcome to create PRs with this change

iconFehu commented 8 months ago

I have created a Pull Request to address this issue. You can find it here.

Note:

These changes aim to enhance the maintainability and consistency of the project while ensuring synchronization across various components. Thank you for your review and merge.