You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
1. Parses through all of the all-contributors bot `.json` files across our pyOpenSci repos to gather contributors to
25
-
our organization. This allows us to [acknowledge contributors on our website](https://www.pyopensci.org/our-community/#pyopensci-community-contributors)
26
-
who are not always making explicit code contributions (thus might not have commits). These contributors are
27
-
reviewing guidebooks, participating in peer review, and performing other important tasks that are critical to our
28
-
pyOpenSci mission. We acknowledge all contributions at pyOpenSci regardless of volume or size.
29
-
2. Updates the existing [contributors.yml](https://github.com/pyOpenSci/pyopensci.github.io/blob/main/_data/contributors.yml)
30
-
file found in our website repo with new contributors and the contributor role (package guides, code workflows, peer review, etc).
31
-
If you run the script using `--update update_all`, this script will also use the GitHub api to update the users metadata from their GitHub profile.
24
+
1. Parses through all of the all-contributors bot `.json` files across our pyOpenSci repos to gather contributors to
25
+
our organization. This allows us to [acknowledge contributors on our website](https://www.pyopensci.org/our-community/#pyopensci-community-contributors)
26
+
who are not always making explicit code contributions (thus might not have commits). These contributors are
27
+
reviewing guidebooks, participating in peer review, and performing other important tasks that are critical to our
28
+
pyOpenSci mission. We acknowledge all contributions at pyOpenSci regardless of volume or size.
29
+
2. Updates the existing [contributors.yml](https://github.com/pyOpenSci/pyopensci.github.io/blob/main/_data/contributors.yml)
30
+
file found in our website repo with new contributors and the contributor role (package guides, code workflows, peer review, etc).
31
+
If you run the script using `--update update_all`, this script will also use the GitHub api to update the users metadata from their GitHub profile.
32
32
33
33
## update-reviews script
34
34
35
35
To run this script, you can call the following at the command line:
36
36
37
37
`update-reviews`
38
38
39
-
This script parses through our (_accepted_) review issues to find packages that have been accepted. It then grabs each
39
+
This script parses through our (*accepted*) review issues to find packages that have been accepted. It then grabs each
40
40
reviews editor, reviewers and package authors / maintainers. This information allows us to
41
41
42
-
1. Update a contributor's peer review metadata in the contributors.yml file in the third script.
43
-
2. Update the pyOpenSci website's package listing with the package's DOI, documentation URL.
44
-
3. Update the package's stats including stars, contributors, etc. using the GitHub API
42
+
1. Update a contributor's peer review metadata in the contributors.yml file in the third script.
43
+
2. Update the pyOpenSci website's package listing with the package's DOI, documentation URL.
44
+
3. Update the package's stats including stars, contributors, etc. using the GitHub API
45
45
46
-
## process_reviews.py script
46
+
## process\_reviews.py script
47
47
48
48
To run this script, you can call the following at the command line:
49
49
@@ -52,28 +52,28 @@ To run this script, you can call the following at the command line:
52
52
This final script is a bridge between the first it uses pickle files outputted from the
53
53
first two scripts to update each contributors peer review contributions including
54
54
55
-
1. packages submitted or reviewed
56
-
2. packages in which the contributor served as editors
57
-
3. contributor types associated with peer review including:
55
+
1. packages submitted or reviewed
56
+
2. packages in which the contributor served as editors
57
+
3. contributor types associated with peer review including:
58
58
59
-
- peer-review
60
-
- package-maintainer
61
-
- package-reviewer
62
-
- package-editor
59
+
* peer-review
60
+
* package-maintainer
61
+
* package-reviewer
62
+
* package-editor
63
63
64
64
These general contributor types are used to drive our
65
65
[website's contributor search and filter functionality that you can see here.](https://www.pyopensci.org/our-community/index.html#pyopensci-community-contributors)
66
66
67
67
## Local setup
68
68
69
-
1. Create a local environment and activate it. If you are using conda:
69
+
1. Create a local environment and activate it. If you are using conda:
70
70
71
-
```bash
72
-
mamba create -n pyos-meta python=3.10
73
-
mamba activate pyos-meta
74
-
```
71
+
```bash
72
+
mamba create -n pyos-meta python=3.10
73
+
mamba activate pyos-meta
74
+
```
75
75
76
-
2. Install the package in editable mode and associated development dependencies:
76
+
2. Install the package in editable mode and associated development dependencies:
1. Duplicate the `.env-default` file and rename the copy to `.env`
90
-
2. Assign your token to the `GITHUB_TOKEN` variable in the `.env` file.
89
+
1. Duplicate the `.env-default` file and rename the copy to `.env`
90
+
2. Assign your token to the `GITHUB_TOKEN` variable in the `.env` file.
91
91
92
92
## How to run each script
93
93
@@ -102,45 +102,45 @@ To run:
102
102
103
103
The `update-contributors` script does the following:
104
104
105
-
1. It grabs the `all-contribs.json` files from each repository and turns that json data into a dictionary of all unique
106
-
contributors across repos. Repos include:
107
-
- peer review guide
108
-
- packaging guide
109
-
- website
110
-
- software-review
111
-
- update-package-meta (this repo)
112
-
2. It then:
105
+
1. It grabs the `all-contribs.json` files from each repository and turns that json data into a dictionary of all unique
106
+
contributors across repos. Repos include:
107
+
* peer review guide
108
+
* packaging guide
109
+
* website
110
+
* software-review
111
+
* update-package-meta (this repo)
112
+
2. It then:
113
113
114
114
If you use the `--update update_all` flag, it will:
115
115
116
-
- Update contrib profile information including name using whatever information is available their public github
117
-
account for website, location, organization, twitter, etc).
118
-
- Check to see that the website in their profile works, if not removes it so it doesn't begin to fail our website ci tests.
116
+
* Update contrib profile information including name using whatever information is available their public github
117
+
account for website, location, organization, twitter, etc).
118
+
* Check to see that the website in their profile works, if not removes it so it doesn't begin to fail our website ci tests.
119
119
120
120
Without the `update` flag, running `update-contributors` will only add any new users that
121
121
are not already in the website `contributors.yml` file to a output `.pickle` file.
122
122
123
123
### update-reviews Returns:
124
124
125
-
-`all-contributors.pickle` file that will be used in the final update-reviewers script to update all reviewer contribution data.
125
+
*`all-contributors.pickle` file that will be used in the final update-reviewers script to update all reviewer contribution data.
126
126
127
127
## update-reviews script
128
128
129
129
To run:
130
130
`update-reviews` or
131
131
`update-reviews --update update_all`
132
132
133
-
- This script parses through all pyOpenSci issues in the [software-submissions repo](https://github.com/pyOpenSci/software-submission) issues where the issue has a label of 6/`pyOS-approved 🚀🚀🚀`.
134
-
- Grabs crucial metadata including the reviewers and editors for each.
135
-
- Adds people who have participated in peer review who are NOT listed currently in the website `contributors.yml` file
133
+
* This script parses through all pyOpenSci issues in the [software-submissions repo](https://github.com/pyOpenSci/software-submission) issues where the issue has a label of 6/`pyOS-approved 🚀🚀🚀`.
134
+
* Grabs crucial metadata including the reviewers and editors for each.
135
+
* Adds people who have participated in peer review who are NOT listed currently in the website `contributors.yml` file
136
136
137
137
It then collects the
138
138
GitHub id and user information for:
139
139
140
-
- reviewers,
141
-
- submitting authors,
142
-
- editors and
143
-
- maintainers.
140
+
* reviewers,
141
+
* submitting authors,
142
+
* editors and
143
+
* maintainers.
144
144
145
145
Finally, it updates GitHub statistics for
146
146
each packages including stars, last commit date and more repo metadata.
@@ -149,15 +149,15 @@ each packages including stars, last commit date and more repo metadata.
149
149
150
150
This returns a `packages.pickle` file that will be used in the final script which bridges data between the first two scripts.
151
151
152
-
## update_reviewers script`
152
+
## update\_reviewers script\`
153
153
154
154
This script is a bridge between `update-contributors` and `update-reviews`. It parses each review in the output
155
155
`update-reviews.pickle` file and
156
156
157
-
1. updates contributor name in the review data (often the github username is there but the first and last name is missing).
158
-
This allows us to publish the maintainer names (rather than github usernames) [on our website package listing.](https://www.pyopensci.org/python-packages.html#explore-our-accepted-scientific-python-open-source-packages)
159
-
2. Updates each review issue contributor's name in the contributor metadata. This allows us to ensure we have updated
160
-
contributor types, package submission information etc, in the contributor.yml file on our website.
157
+
1. updates contributor name in the review data (often the github username is there but the first and last name is missing).
158
+
This allows us to publish the maintainer names (rather than github usernames) [on our website package listing.](https://www.pyopensci.org/python-packages.html#explore-our-accepted-scientific-python-open-source-packages)
159
+
2. Updates each review issue contributor's name in the contributor metadata. This allows us to ensure we have updated
160
+
contributor types, package submission information etc, in the contributor.yml file on our website.
161
161
162
162
To run:
163
163
`update_reviewers`
@@ -168,8 +168,8 @@ This final script uses the two pickle files
168
168
to update information. It then returns
169
169
two output files:
170
170
171
-
1.`_data/contributors.yml`
172
-
2.`_data/packages.yml`
171
+
1.`_data/contributors.yml`
172
+
2.`_data/packages.yml`
173
173
174
174
Each are stored in the `/_data/file.yml` directory to mimic the directory structure of our website.
175
175
@@ -180,8 +180,8 @@ actions located here](https://github.com/pyOpenSci/pyopensci.github.io/tree/main
0 commit comments