Skip to main content

Tools that update the pyOpenSci contributor and review metadata that is posted on our website

Project description

pyosmeta

PyPI License CITE DOI

Run pyos meta tests codecov Update Contribs & reviewers Publish to PyPI .github/workflows/test-run-script.yml

Description

pyosmeta provides the tools and scripts used to manage pyOpenSci's contributor and peer review metadata. This repo contains several modules and several CLI scripts, including:

  • parse-history
  • update-contributors
  • update-reviews
  • update-review-teams

Since pyOpenSci uses this tool for its website, we expect this package to have infrequent releases.

Installation

Using pip:

pip install pyosmeta

Using conda:

conda install pyosmeta

Usage

See CONTRIBUTING.md.

This repo contains several modules and several CLI scripts, including:

  • parse-history
    • This script:
      1. gets a list of all contributors
      2. parses through the commit history (locally) to figure out when they were added to the contributor.yml file
      3. then it adds a date_Added key for that person This will allow us to ensure the yaml file retains order when users are highlighted as "new" and also for diff's in git.
  • update-contributors
    • This script parses through and updates the existing contributor list stored in pyopensci.github.io repo in the _data/contributors.yml file.
    • That's used to populate the community page, and to update our metrics page.
  • update-reviews
    • This script parses metadata from and issue and adds it to a .yml file for the website. It also grabs some of the package metadata such as stars, last commit, etc.
    • It outputs a packages.yml file with all packages with accepted reviews; information related to the review; basic package stats; and partner information.
  • update-review-teams
    • This script parses through our packages.yml and contributors.yml.
    • It:
      1. Updates reviewer, editor and maintainer data in the contributor.yml file to ensure all packages they supported are listed there. 1b: And that they have a listing as peer-review under contributor type
      2. Finally it looks to see if we are missing review participants from the review issues in the contributor file and updates that file.
    • Warning: This script assumes that update_contributors and update_reviews has been run. Rather than hit any api's it just updates information from the issues.

Note: this section will be rewritten to be more user focused.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Ivan Ogasawara
Ivan Ogasawara

💻 👀 🎨
Meer (Miriam) Williamson
Meer (Miriam) Williamson

💻 👀
Tiffany Xiao
Tiffany Xiao

💻 👀
austinlg96
austinlg96

💻 👀 🎨
JAKE
JAKE

👀 💻 🎨
Luiz Irber
Luiz Irber

💻 👀
Barnabas Bulpett (He/Him)
Barnabas Bulpett (He/Him)

💻 👀
Juanita Gomez
Juanita Gomez

💻 👀
Sarah Kaiser
Sarah Kaiser

💻 👀
Sultan Orazbayev
Sultan Orazbayev

💻 👀
Simon
Simon

💻 👀
Carol Willing
Carol Willing

💻 👀
Ofek Lev
Ofek Lev

💻 👀
Sviatoslav Sydorenko (Святослав Сидоренко)
Sviatoslav Sydorenko (Святослав Сидоренко)

💻 👀
Steven Silvester
Steven Silvester

💻 👀
P. L. Lim
P. L. Lim

💻 👀
Jonny Saunders
Jonny Saunders

💻 👀
Elise Hinman
Elise Hinman

💻 👀
Hari Prakash Vel Murugan
Hari Prakash Vel Murugan

📖
mrgah
mrgah

💻 👀
Kerry McAdams
Kerry McAdams

💻 👀
Cheng H. Lee
Cheng H. Lee

👀
steven
steven

💻 👀
Inessa Pawson
Inessa Pawson

👀 💻 🚇

This project follows the all-contributors specification. Contributions of any kind welcome!

Contributing

CONTRIBUTING.md

Development

Development guide

Change log

CHANGELOG.md

Code of Conduct

Everyone interacting in the pyOpenSci project's codebases, issue trackers, chat rooms, and communication venues is expected to follow the pyOpenSci Code of Conduct.

License

MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyosmeta-1.7.7.tar.gz (4.2 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyosmeta-1.7.7-py3-none-any.whl (40.5 kB view details)

Uploaded Python 3

File details

Details for the file pyosmeta-1.7.7.tar.gz.

File metadata

  • Download URL: pyosmeta-1.7.7.tar.gz
  • Upload date:
  • Size: 4.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pyosmeta-1.7.7.tar.gz
Algorithm Hash digest
SHA256 14e1340bb5384f2d8976305f0c89b41d9779ca2330fc11fd84fe0d216bbbb1a6
MD5 b59d42524b7a161a3690a06cd1c0cb51
BLAKE2b-256 7eb1a409e3a9316a88f42842b3a1a80b1665f8e5c7db469e8fd57d5d12fe4d02

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyosmeta-1.7.7.tar.gz:

Publisher: publish-pypi.yml on pyOpenSci/pyosMeta

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyosmeta-1.7.7-py3-none-any.whl.

File metadata

  • Download URL: pyosmeta-1.7.7-py3-none-any.whl
  • Upload date:
  • Size: 40.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pyosmeta-1.7.7-py3-none-any.whl
Algorithm Hash digest
SHA256 4299f38221c2a6a7664156f3fcf7cc314dd78753b315d6f644d4f676de513eab
MD5 196a622da388f20564ef000f9cd67208
BLAKE2b-256 c1f871646a4b6c18d69ae6dcdebffa2f018a365fda0d22a390f60449b13db4cf

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyosmeta-1.7.7-py3-none-any.whl:

Publisher: publish-pypi.yml on pyOpenSci/pyosMeta

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page