Simple script to generate AUTHORS.rst from .zenodo.json file #3995
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,67 +1,64 @@ | ||
| ISIS3 Contributors | ||
| ================== | ||
|
|
||
| - Jason Laura | ||
| - Jesse Mapel | ||
| - Kristin Berry | ||
| - Kaitlyn Lee | ||
| - Kelvin Rodriguez | ||
| - Stuart Sides | ||
| - Adam Paquette | ||
| - Kaj Williams | ||
| - Austin Sanders | ||
| - Lauren Adoram-Kershner | ||
| - John Shinaman | ||
| - Lynn Weller | ||
| - Evin Dunn | ||
| - Tim Giroux | ||
| - Tracie Sucharski | ||
| - Jeanie Backer | ||
| - Adam Goins | ||
| - Makayla Shepard | ||
| - Christopher Combs | ||
| - Debbie Cook | ||
| - Kris Becker | ||
| - Summer Stapleton | ||
| - Cole Neubauer | ||
| - Tyler Wilson | ||
| - Aaron Giroux | ||
| - Moses Milazzo | ||
| - Ross Beyer | ||
| - Elpitha Howington-Kraus | ||
| - Kenneth Edmundson | ||
| - Raad Saleh | ||
| - Oleg Alexandrov | ||
| - Aaron Curtis | ||
| - Eric Gault | ||
| - Andrew Annex | ||
| - Victor Silva | ||
| - Benoit Seignovert | ||
| - Andrew Stebenne | ||
| - Christopher Austin | ||
| - Curtis Rose | ||
| - David Miller | ||
| - Ella Mae Lee | ||
| - Eric Heyer | ||
| - Ian Humphrey | ||
| - Jai Rideout | ||
| - James Alexander Crough | ||
| - Janet Barrett | ||
| - Jeff Anderson | ||
| - Jeffrey Covington | ||
| - John Bonn | ||
| - Kim Oyama | ||
| - Mackenzie Boyd | ||
| - Marjorie Hahn | ||
| - Mathew Eis | ||
| - Orrin Thomas | ||
| - Sasha Brownsberger | ||
| - Sharmilla Prasad | ||
| - Steven Lambright | ||
| - Travis Addair | ||
|
|
||
| ----- | ||
| This list was generated from the .zenodo.json file by running python zenodo_to_authors.py. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| # Uses the .zenodo.json file to generate an AUTHORS.rst file. | ||
| # No arguments are necessary. Just set $ISISROOT and run: python zenodo_to_authors.py | ||
|
|
||
| import os | ||
|
|
||
| # Files to open | ||
| if "ISISROOT" in os.environ: | ||
| zenodo_path = os.path.expandvars("$ISISROOT/../.zenodo.json") | ||
| authors_path = os.path.expandvars("$ISISROOT/../AUTHORS.rst") | ||
| else: | ||
| print("Please set $ISISROOT and re-run this script.") | ||
| exit() | ||
|
|
||
| # Read .zenodo.json file: | ||
| lines = [] | ||
|
There was a problem hiding this comment. This looks like it's no longer needed |
||
| with open(zenodo_path, 'r') as zenodo_file: | ||
| lines = zenodo_file.readlines() | ||
|
|
||
| output_lines = ["ISIS3 Contributors", "==================\n"] | ||
|
|
||
| for line in lines: | ||
| # Pull the names out of the zenodo file and reformat | ||
| if "\"name\"" in line: | ||
| name = line.strip().split(":")[1].strip("\", ") | ||
| last, first = name.split(",") | ||
| output_lines.append("- {} {}".format(first.strip(),last.strip())) | ||
|
|
||
| output_lines.append("\n-----") | ||
| output_lines.append("This list was generated from the .zenodo.json file by running python zenodo_to_authors.py.") | ||
|
|
||
| # Write to AUTHORS.rst file | ||
| with open(authors_path, 'w') as authors_file: | ||
| authors_file.write('\n'.join(output_lines)) | ||
|
There was a problem hiding this comment. You should add similar exception logic for writing the output file as you did for reading the input file. |
||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I do not like setting the defaults and then having to do this; especially, because this could error. My rule of thumb is that a script with default arguments should be able to just run; if I have to set environment variables to run it with default arguments I may as well just pass the arguments. I would just make the arguments required.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can do. My initial thought was that the default use of this script would be automated (in the future!) rather than normally being something an individual user would run, so I was thinking "$ISISROOT" is set would be the default case. I see your point, though, and am happy to just remove the defaults and make the arguments required.