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

Use new project metadata format [PEP 621] #72422

Merged
merged 3 commits into from
May 25, 2022

Conversation

cdce8p
Copy link
Member

@cdce8p cdce8p commented May 24, 2022

Proposed change

Starting with v61.0.0, setuptools added support for the (new) project metadata format PEP 621. Although it's currently still experimental, all major features have been implemented and it's possible for us to move most project metadata from setup.cfg to pyproject.toml.

Some keys can't be moved quite yet:

  • version and python_requires -> need to update actions and scripts first. Will follow later
  • install_requires -> The field is dynamically written by the gen_requirements_all.py script. Writing toml is more difficult than ini files. Will need to investigate options. For now setting dependencies as dynamic will allow us to fall back to install_requires.
  • url -> intended to be merged with [project.urls]. However, there is an open bug in pypa warehose regarding the sort order. To guarantee the Home-Page is listed first, we can continue using url for now.
    Project Links in left navbar display in reverse order from setup.py project_urls pypi/warehouse#3097

The resulting metadata file is almost identical. The only exceptions: Author-email uses a new (autogenerated) format, I added the missing classifier for Python 3.10, and some trailing whitespace changes.

-Author: The Home Assistant Authors
-Author-email: hello@home-assistant.io
+Author-email: The Home Assistant Authors <hello@home-assistant.io>
...
+Classifier: Programming Language :: Python :: 3.10

Links
https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html
https://packaging.python.org/en/latest/specifications/declaring-project-metadata/
https://peps.python.org/pep-0621/

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • The code has been formatted using Black (black --fast homeassistant tests)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
  • Untested files have been added to .coveragerc.

The integration reached or maintains the following Integration Quality Scale:

  • No score or internal
  • 🥈 Silver
  • 🥇 Gold
  • 🏆 Platinum

To help with the load of incoming pull requests:

@cdce8p cdce8p requested a review from a team as a code owner May 24, 2022 12:10
@probot-home-assistant probot-home-assistant bot added the small-pr PRs with less than 30 lines. label May 24, 2022
pyproject.toml Outdated Show resolved Hide resolved
pyproject.toml Outdated
]
keywords = ["home", "automation"]
classifiers = [
"Development Status :: 4 - Beta",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might be time to remove beta from this? 😬

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thought so too, just wasn't sure. I changed it to Development Status :: 5 - Production/Stable.
I can revert it if that's not what you were going for.

@balloob balloob merged commit d000868 into home-assistant:dev May 25, 2022
@cdce8p cdce8p deleted the metadata-pep-621 branch May 25, 2022 02:11
@github-actions github-actions bot locked and limited conversation to collaborators May 26, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
cla-signed small-pr PRs with less than 30 lines.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants