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

Improve package metadata #3445

Merged
merged 1 commit into from
Nov 8, 2021
Merged

Improve package metadata #3445

merged 1 commit into from
Nov 8, 2021

Conversation

cthoyt
Copy link
Contributor

@cthoyt cthoyt commented Nov 7, 2021

This pull request does three things:

  1. Updates an old key in setup.cfg so the README.md file is properly displayed on PyPI (i.e., switch from description-file to the pair of long_description/long_description_content_type)
  2. Adds application of pyroma to the linting configuration for GitHub Actions to check the package metadata is completely filled out
  3. Fill out the missing package metadata in setup.cfg

A little context, if you run pyroma on the current PyPI version of PyG:

$ pyroma -p torch_geometric
------------------------------
Checking torch_geometric
Starting new HTTPS connection (1): pypi.org:443
https://pypi.org:443 "GET /pypi/torch_geometric/json HTTP/1.1" 301 223
https://pypi.org:443 "GET /pypi/torch-geometric/json HTTP/1.1" 200 5146
Found torch_geometric version 2.0.2
Downloading torch_geometric-2.0.2.tar.gz to verify distribution
Starting new HTTPS connection (1): files.pythonhosted.org:443
https://files.pythonhosted.org:443 "GET /packages/05/52/b0bf572b72fb3fd0b57eabd3c46f25d128579c586dfbe25cc4f9d4163306/torch_geometric-2.0.2.tar.gz HTTP/1.1" 200 325559
/Users/cthoyt/.virtualenvs/pykeen/lib/python3.9/site-packages/setuptools/dist.py:717: UserWarning: Usage of dash-separated 'description-file' will not be supported in future versions. Please use the underscore name 'description_file' instead
  warnings.warn(
Found torch-geometric
------------------------------
The package's long_description is quite short.
Your package does not have classifiers data.
You should specify what Python versions you support.
Your package does neither have a license field nor any license classifiers.
You should have three or more owners of the project on PyPI.
Specifying a development status in the classifiers gives users a hint of how stable your software is.
------------------------------
Final rating: 6/10
Comté
------------------------------

@codecov-commenter
Copy link

codecov-commenter commented Nov 7, 2021

Codecov Report

Merging #3445 (9e4d58e) into master (6961b16) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #3445   +/-   ##
=======================================
  Coverage   81.70%   81.70%           
=======================================
  Files         291      291           
  Lines       14459    14459           
=======================================
  Hits        11814    11814           
  Misses       2645     2645           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6961b16...9e4d58e. Read the comment docs.

@rusty1s
Copy link
Member

rusty1s commented Nov 8, 2021

This is great! Thank you so much.

@rusty1s rusty1s merged commit 0ea9a75 into pyg-team:master Nov 8, 2021
@cthoyt cthoyt deleted the add-pyroma branch November 8, 2021 09:52
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.

3 participants