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 a pyproject and a separate INSTALL.md #137

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

gnebie
Copy link

@gnebie gnebie commented Mar 2, 2025

Add a pyproject file and a detailled separate installation file with a poetry installation walkthrough to not overcharge the readme.

Why Add a pyproject.toml File?

The pyproject.toml file is a modern, standardized way to configure Python projects. Introduced by PEP 518, it provides a unified format for defining project metadata, dependencies, and build tools. It replaces older, fragmented configurations like setup.py, setup.cfg, and requirements.txt.

Key Benefits
  • Standardization → A single configuration file for package metadata, dependencies, and build settings.
  • Tooling Support → Compatible with setuptools, poetry, flit, hatch, and other modern Python package managers.
  • Improved Dependency Management → Enables precise dependency specification and optional development dependencies.
  • Better Build Isolation → Clearly defines the build system (setuptools, poetry-core, etc.), making installations more reproducible.
  • Cleaner Project Structure → Reduces clutter by consolidating configuration settings in a single file.

By adopting pyproject.toml, projects become more portable, easier to maintain, and compatible with modern Python tooling, ensuring a smoother development experience.

…try installation to not overcharge the readme
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant