Enhance setup.py with best practices #83
Open
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 enhances the setup.py script for the stable-audio-tools package by incorporating several best practices for Python packaging. Changes: 1. Added the `author_email` parameter to include the email address of the package author. 2. Included the contents of the README.md file as the `long_description` parameter, allowing users to view the full package documentation on package repositories like PyPI. 3. Set the `long_description_content_type` parameter to "text/markdown" to indicate that the long description is in Markdown format, improving readability. 4. Enabled the `include_package_data` parameter to include non-Python files in the package distribution. 5. Added the `classifiers` parameter with relevant metadata about the package, such as its development status, intended audience, license, supported Python versions, and topic. 6. Specified the minimum required Python version using the `python_requires` parameter. 7. Defined an `entry_points` parameter to create a console script entry point for running the package's command-line interface (CLI) after installation. Benefits: - Improved package discoverability and usability by providing more comprehensive metadata and documentation. - Better adherence to Python packaging best practices, making the package more maintainable and compatible with other tools and ecosystems. - Inclusion of non-Python files in the package distribution, ensuring that all necessary resources are available to users. - Ability for users to run the package's CLI directly after installation, simplifying the usage experience. - Compatibility with multiple Python versions by specifying the minimum required version.
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 enhances the setup.py script for the stable-audio-tools package by incorporating several best practices for Python packaging.
Changes:
author_emailparameter to include the email address of the package author.long_descriptionparameter, allowing users to view the full package documentation on package repositories like PyPI.long_description_content_typeparameter to "text/markdown" to indicate that the long description is in Markdown format, improving readability.include_package_dataparameter to include non-Python files in the package distribution.classifiersparameter with relevant metadata about the package, such as its development status, intended audience, license, supported Python versions, and topic.python_requiresparameter.entry_pointsparameter to create a console script entry point for running the package's command-line interface (CLI) after installation.Benefits: