pyosmeta

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.

How the metadata workflow works

The canonical YAML files live in the pyopensci.github.io website repo under data/:

• data/contributors.yml — community page and metrics
• data/packages.yml — accepted peer-reviewed packages and GitHub metrics

A weekly (or manually dispatched) GitHub Action on the website repo (update-contribs-reviews.yml) checks out that repo, installs pyosmeta, runs the three CLIs below in order, then opens a PR with updates to those two files.

flowchart LR
  subgraph website["pyopensci.github.io (website repo)"]
    direction TB
    contribYml["data/contributors.yml"]
    pkgYml["data/packages.yml"]
    contribYml ~~~ pkgYml
  end

  subgraph pyosMeta["pyosMeta package"]
    direction TB
    updateContribs["update-contributors"]
    updateReviews["update-reviews"]
    pickle1["all_contribs.pickle"]
    pickle2["all_reviews.pickle"]
    updateTeams["update-review-teams"]
  end

  website ~~~ pyosMeta

  contribYml -->|"Read existing yml"| updateContribs
  pkgYml -->|"Read existing yml"| updateReviews
  updateContribs --> pickle1 --> updateTeams
  updateReviews --> pickle2 --> updateTeams
  updateTeams -->|"Update yml file"| contribYml
  updateTeams -->|"Update yml file"| pkgYml

Loading

What each step does

1. update-contributors — Loads the published contributors.yml, finds new people from pyOpenSci .all-contributorsrc files, and (with --update) refreshes profile fields from GitHub. If a person already has a name in the YAML, that value is kept and not overwritten from GitHub.
2. update-reviews — Parses accepted review issues, fetches fresh GitHub metrics per package, then gap-fills any missing gh_meta from the existing packages.yml so previously published metrics are not deleted when an API call fails.
3. update-review-teams — Merges the two pickle outputs (no extra API calls), links reviewers/editors/maintainers to packages, and writes data/contributors.yml and data/packages.yml relative to the current working directory (the website checkout in CI).

parse-history is a one-time helper for date_added values; it is not part of the weekly pipeline.

For local setup and how to run the scripts, see the Development Guide.

Installation

pyosMeta is available on PyPI and can be installed with pip:

pip install pyosmeta

Usage

After installing pyosmeta, the main entry points are:

• update-contributors
• update-reviews
• update-review-teams
• parse-history (one-time helper; not part of the weekly pipeline)

See How the metadata workflow works for what each weekly script does, and the Development Guide for how to run them locally.

Contributing

• Contributing guide — how to open issues and pull requests
• Development guide — local setup, CLIs, tests, and releases
• Change log

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Ivan Ogasawara 💻 👀 🎨	Meer (Miriam) Williamson 💻 👀	Tiffany Xiao 💻 👀	austinlg96 💻 👀 🎨	JAKE 👀 💻 🎨	Luiz Irber 💻 👀	Barnabas Bulpett (He/Him) 💻 👀
Juanita Gomez 💻 👀	Sarah Kaiser 💻 👀	Sultan Orazbayev 💻 👀	Simon 💻 👀	Carol Willing 💻 👀	Ofek Lev 💻 👀	Sviatoslav Sydorenko (Святослав Сидоренко) 💻 👀
Steven Silvester 💻 👀	P. L. Lim 💻 👀	Jonny Saunders 💻 👀	Elise Hinman 💻 👀	Hari Prakash Vel Murugan 📖	mrgah 💻 👀	Kerry McAdams 💻 👀
Cheng H. Lee 👀	steven 💻 👀	Inessa Pawson 👀 💻 🚇 🐛	Toshio Kuratomi 💻 👀

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

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