Skip to content

Commit ae0433f

Browse files
committed
add support for specifying quarter and usage section
1 parent 52e1a02 commit ae0433f

1 file changed

Lines changed: 43 additions & 6 deletions

File tree

scripts/3-report/notes.py

Lines changed: 43 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525

2626
# Constants
2727
QUARTER = os.path.basename(PATHS["data_quarter"])
28-
SECTION = "References"
28+
SECTION = "Notes"
2929

3030

3131
def parse_arguments():
@@ -37,26 +37,30 @@ def parse_arguments():
3737
parser.add_argument(
3838
"--quarter",
3939
default=QUARTER,
40-
help="Data quarter in format YYYYQx, e.g., 2024Q2",
40+
help=f"Data quarter in format YYYYQx (default: {QUARTER})",
4141
)
4242
parser.add_argument(
4343
"--show-plots",
4444
action="store_true",
45-
help="Show generated plots (in addition to saving them)",
45+
help="Show generated plots (default: False)",
4646
)
4747
parser.add_argument(
4848
"--enable-save",
4949
action="store_true",
50-
help="Enable saving results",
50+
help="Enable saving results (default: False)",
5151
)
5252
parser.add_argument(
5353
"--enable-git",
5454
action="store_true",
55-
help="Enable git actions (fetch, merge, add, commit, and push)",
55+
help="Enable git actions such as fetch, merge, add, commit, and push"
56+
" (default: False)",
5657
)
5758
args = parser.parse_args()
5859
if not args.enable_save and args.enable_git:
5960
parser.error("--enable-git requires --enable-save")
61+
if args.quarter != QUARTER:
62+
global PATHS
63+
PATHS = shared.update_paths(LOGGER, PATHS, QUARTER, args.quarter)
6064
args.logger = LOGGER
6165
args.paths = PATHS
6266
return args
@@ -77,7 +81,7 @@ def data_locations(args):
7781
"**[creativecommons/quantifying][repo]:** *quantify the size and"
7882
" diversity of the commons--the collection of works that are openly"
7983
" licensed or in the public domain*\n"
80-
"\nThe data used to generate this report is avaiable in that"
84+
"\nThe data used to generate this report is available in that"
8185
" repository at the following locations:\n"
8286
"\n"
8387
" | Resource | Location |\n"
@@ -90,12 +94,45 @@ def data_locations(args):
9094
)
9195

9296

97+
def usage(args):
98+
"""
99+
Write copyright
100+
"""
101+
shared.update_readme(
102+
args,
103+
SECTION,
104+
"Usage",
105+
None,
106+
None,
107+
"The Creative Commons (CC) icons, images, and logos are for use under"
108+
" the Creative Commons Trademark Policy (see [Policies - Creative"
109+
" Commons][ccpolicies]). **They *aren't* licensed under a Creative"
110+
" Commons license** (also see [Could I use a CC license to share my"
111+
" logo or trademark? - Frequently Asked Questions - Creative"
112+
" Commons][tmfaq]).\n"
113+
"\n"
114+
"[![CC0 1.0 Universal (CC0 1.0) Public Domain Dedication"
115+
"button][cc-zero-png]][cc-zero]\n"
116+
"Otherwise, this report is dedicated to the public domain under the"
117+
" [CC0 1.0 Universal (CC0 1.0) Public Domain Dedication][cc-zero].\n"
118+
"\n"
119+
"[ccpolicies]: https://creativecommons.org/policies\n"
120+
"[tmfaq]: https://creativecommons.org/faq/"
121+
"#could-i-use-a-cc-license-to-share-my-logo-or-trademark\n"
122+
"[cc-zero-png]: https://licensebuttons.net/l/zero/1.0/88x31.png"
123+
' "CC0 1.0 Universal (CC0 1.0) Public Domain Dedication button"\n'
124+
"[cc-zero]: https://creativecommons.org/publicdomain/zero/1.0/"
125+
' "Creative Commons — CC0 1.0 Universal"',
126+
)
127+
128+
93129
def main():
94130
args = parse_arguments()
95131
shared.log_paths(LOGGER, PATHS)
96132
shared.git_fetch_and_merge(args, PATHS["repo"])
97133

98134
data_locations(args)
135+
usage(args)
99136

100137
args = shared.git_add_and_commit(
101138
args,

0 commit comments

Comments
 (0)