README: About pyOpenSci peer review metrics

This is a dashboard created using mystmd . Myst-md is a community developed tool that makes it easier for scientists to create fully reproducible (and interactive) workflows and reports that are easily shared.

How to Contribute

1. Fork and Clone the Repo:

To begin, fork this repository to your GitHub account. Then, clone it locally to work on a branch from your computer.

2. Create your GitHub token

The code in this repository uses the GitHub REST API. To ensure that you can access and make requests to the API, you will need to create a token in your GitHUb account.

Through the pyOpenSci pyosMeta package. This package was created to parse through pyOpenSci software review issues, and obtain both contributor and package metadata. To use this package, you need to supply a GitHub access token. This token can be created from your personal GitHub account.

NOTE: You do not need special access to the pyOpenSci organization for this workflow because all of our repositories are public!

Create your token

In GitHub, click on your profile image and navigate to "Settings", and then "Developer Settings".

Create a new fine-grained personal access token, adding a name, expiration, description, and ensure the "Repository Access" is set to "Public Repositories (read-only)". No other configuration needed. At the bottom of the page, click "Generate token".

3. Store token information in an .env file

Copy the .env-default file in this repository and rename it to .env. You will paste your GitHub token value that you created above into this file.

Copy the token string and paste it into the .env file next to GITHUB_TOKEN=. It should look somethign like this

GITHUB_TOKEN=yourtokenvaluehere

You are now setup to process pyOpenSci peer review and contributor metadata using pyosMeta.

Build the website using Nox

You can use nox to build the site locally. Nox will create an venv environment for you with all needed dependencies to run the code and build the peer review metrics dashboard.

To start, install nox:

Using pip:

python -m pip install nox

or pipx for global install:

pipx install nox

Build a static html website

To build the html version of the dashboard use

nox -s build

Build a live local server dashboard

To build the dashboard as a local server that will update as you update the files use:

nox -s serve

One a mac you can use ctrl + d to stop a live server.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

kaiyamag 💻 👀

Elise Hinman 💻 👀

Santiago Soler 💻 👀

Franklin Koch 💻 👀

Angus Hollands 💻 👀

Alex Batisse 💻 👀

Carol Willing 💻 👀

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