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 our organization. This allows us to [acknowledge contributors on our website](https://www.pyopensci.org/our-community/#pyopensci-community-contributors) who are not always making explicit code contributions (thus might not have commits). These contributors are reviewing guidebooks, participating in peer review, and performing other important tasks that are critical to our pyOpenSci mission. We acknowledge all contributions at pyOpenSci regardless of volume or size.
25
-
2. Updates the existing [contributors.yml](https://github.com/pyOpenSci/pyopensci.github.io/blob/main/_data/contributors.yml) file found in our website repo with new contributors and the contributor role (package guides, code workflows, peer review, etc).
26
-
a. 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 our organization. This allows us to [acknowledge contributors on our website](https://www.pyopensci.org/our-community/#pyopensci-community-contributors) who are not always making explicit code contributions (thus might not have commits). These contributors are reviewing guidebooks, participating in peer review, and performing other important tasks that are critical to our pyOpenSci mission. We acknowledge all contributions at pyOpenSci regardless of volume or size.
25
+
2. Updates the existing [contributors.yml](https://github.com/pyOpenSci/pyopensci.github.io/blob/main/_data/contributors.yml) file found in our website repo with new contributors and the contributor role (package guides, code workflows, peer review, etc).
26
+
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.
27
27
28
28
## update-reviews script
29
29
@@ -33,9 +33,9 @@ To run this script, you can call the following at the command line:
33
33
34
34
This script parses through our (_accepted_) review issues to find packages that have been accepted. It then grabs each reviews editor, reviewers and package authors / maintainers. This information allows us to
35
35
36
-
1. Update a contributor's peer review metadata in the contributors.yml file in the third script.
37
-
2. Update the pyOpenSci website's package listing with the package's DOI, documentation URL.
38
-
3. Update the package's stats including stars, contributors, etc. using the GitHub API
36
+
1. Update a contributor's peer review metadata in the contributors.yml file in the third script.
37
+
2. Update the pyOpenSci website's package listing with the package's DOI, documentation URL.
38
+
3. Update the package's stats including stars, contributors, etc. using the GitHub API
39
39
40
40
## process_reviews.py script
41
41
@@ -46,28 +46,28 @@ To run this script, you can call the following at the command line:
46
46
This final script is a bridge between the first it uses pickle files outputted from the
47
47
first two scripts to update each contributors peer review contributions including
48
48
49
-
1. packages submitted or reviewed
50
-
2. packages in which the contributor served as editors
51
-
3. contributor types associated with peer review including:
49
+
1. packages submitted or reviewed
50
+
2. packages in which the contributor served as editors
51
+
3. contributor types associated with peer review including:
52
52
53
-
- peer-review
54
-
- package-maintainer
55
-
- package-reviewer
56
-
- package-editor
53
+
- peer-review
54
+
- package-maintainer
55
+
- package-reviewer
56
+
- package-editor
57
57
58
58
These general contributor types are used to drive our [website's
59
59
contributor search and filter functionality that you can see here.](https://www.pyopensci.org/our-community/index.html#pyopensci-community-contributors)
60
60
61
61
## Local setup
62
62
63
-
1. Create a local environment and activate it. If you are using conda:
63
+
1. Create a local environment and activate it. If you are using conda:
64
64
65
65
```bash
66
66
mamba create -n pyos-meta python=3.10
67
67
mamba activate pyos-meta
68
68
```
69
69
70
-
2. Install the package in editable mode and associated development dependencies:
70
+
2. Install the package in editable mode and associated development dependencies:
1. Duplicate the `.env-default` file and rename the copy to `.env`
84
-
2. Assign your token to the `GITHUB_TOKEN` variable in the `.env` file.
83
+
1. Duplicate the `.env-default` file and rename the copy to `.env`
84
+
2. Assign your token to the `GITHUB_TOKEN` variable in the `.env` file.
85
85
86
86
## How to run each script
87
87
@@ -96,44 +96,44 @@ To run:
96
96
97
97
The `update-contributors` script does the following:
98
98
99
-
1. It grabs the `all-contribs.json` files from each repository and turns that json data into a dictionary of all unique contributors across repos. Repos include:
100
-
- peer review guide
101
-
- packaging guide
102
-
- website
103
-
- software-review
104
-
- update-package-meta (this repo)
105
-
2. It then:
99
+
1. It grabs the `all-contribs.json` files from each repository and turns that json data into a dictionary of all unique contributors across repos. Repos include:
100
+
- peer review guide
101
+
- packaging guide
102
+
- website
103
+
- software-review
104
+
- update-package-meta (this repo)
105
+
2. It then:
106
106
107
107
If you use the `--update update_all` flag, it will:
108
108
109
-
- Update contrib profile information including name using whatever information is available their public github
110
-
account for website, location, organization, twitter, etc).
111
-
- 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.
109
+
- Update contrib profile information including name using whatever information is available their public github
110
+
account for website, location, organization, twitter, etc).
111
+
- 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.
112
112
113
113
Without the `update` flag, running `update-contributors` will only add any new users that
114
114
are not already in the website `contributors.yml` file to a output `.pickle` file.
115
115
116
116
### update-reviews Returns:
117
117
118
-
-`all-contributors.pickle` file that will be used in the final update-reviewers script to update all reviewer contribution data.
118
+
-`all-contributors.pickle` file that will be used in the final update-reviewers script to update all reviewer contribution data.
119
119
120
120
## update-reviews script
121
121
122
122
To run:
123
123
`update-reviews` or
124
124
`update-reviews --update update_all`
125
125
126
-
- 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 🚀🚀🚀`.
127
-
- Grabs crucial metadata including the reviewers and editors for each.
128
-
- Adds people who have participated in peer review who are NOT listed currently in the website `contributors.yml` file
126
+
- 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 🚀🚀🚀`.
127
+
- Grabs crucial metadata including the reviewers and editors for each.
128
+
- Adds people who have participated in peer review who are NOT listed currently in the website `contributors.yml` file
129
129
130
130
It then collects the
131
131
GitHub id and user information for:
132
132
133
-
- reviewers,
134
-
- submitting authors,
135
-
- editors and
136
-
- maintainers.
133
+
- reviewers,
134
+
- submitting authors,
135
+
- editors and
136
+
- maintainers.
137
137
138
138
Finally, it updates GitHub statistics for
139
139
each packages including stars, last commit date and more repo metadata.
@@ -147,8 +147,8 @@ This returns a `packages.pickle` file that will be used in the final script whic
147
147
This script is a bridge between `update-contributors` and `update-reviews`. It parses each review in the output
148
148
`update-reviews.pickle` file and
149
149
150
-
1. updates contributor name in the review data (often the github username is there but the first and last name is missing). 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)
151
-
2. Updates each review issue contributor's name in the contributor metadata. This allows us to ensure we have updated contributor types, package submission information etc, in the contributor.yml file on our website.
150
+
1. updates contributor name in the review data (often the github username is there but the first and last name is missing). 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)
151
+
2. Updates each review issue contributor's name in the contributor metadata. This allows us to ensure we have updated contributor types, package submission information etc, in the contributor.yml file on our website.
152
152
153
153
To run:
154
154
`update_reviewers`
@@ -159,8 +159,8 @@ This final script uses the two pickle files
159
159
to update information. It then returns
160
160
two output files:
161
161
162
-
1.`_data/contributors.yml`
163
-
2.`_data/packages.yml`
162
+
1.`_data/contributors.yml`
163
+
2.`_data/packages.yml`
164
164
165
165
Each are stored in the `/_data/file.yml` directory to mimic the directory structure of our website.
166
166
@@ -171,8 +171,8 @@ actions located here](https://github.com/pyOpenSci/pyopensci.github.io/tree/main
0 commit comments