@@ -181,56 +181,53 @@ genattrib.py
181181
182182Syntax
183183------
184+ Usage: genattrib.py [options] input_path output_path component_list
184185
185- Usage: genattrib.py [options] input_path output_path component_list
186-
187- Input can be a file or directory.
188- Output of rendered template must be a file (e.g. .html).
189- Component List must be a .csv file which has at least an "about_file" column.
190-
191-
192- Options:
193- -h, --help Display help
194- -v, --version Display current version, license notice, and copyright notice
195- --overwrite Overwrites the output file if it exists
196- --verbosity=VERBOSITY
197- Print more or fewer verbose messages while processing ABOUT files
198- 0 - Do not print any warning or error messages, just a total count (default)
199- 1 - Print error messages
200- 2 - Print error and warning messages
186+ Input can be a file or directory.
187+ Output of rendered template must be a file (e.g. .html).
188+ Component List must be a .csv file which has at least an "about_file" column.
201189
202- --template_location=TEMPLATE_LOCATION
203- Use the custom template for the Attribution Generation
204190
205- --mapping Configure the mapping key from the MAPPING.CONFIG
191+ Options:
192+ -h, --help Display help
193+ -v, --version Display current version, license notice, and copyright notice
194+ --overwrite Overwrites the output file if it exists
195+ --verbosity=VERBOSITY
196+ Print more or fewer verbose messages while processing ABOUT files
197+ 0 - Do not print any warning or error messages, just a total count (default)
198+ 1 - Print error messages
199+ 2 - Print error and warning messages
200+
201+ --template_location=TEMPLATE_LOCATION
202+ Use the custom template for the Attribution Generation
203+
204+ --mapping Configure the mapping key from the MAPPING.CONFIG
206205
207206Purpose
208207-------
208+ Generate an Attribution HTML file which contains the license information from
209+ the 'component_list' along with the license text.
209210
210- Generate an Attribution HTML file which contains the license information from
211- the 'component_list' along with the license text.
212-
213- This tool will look at the components in the 'component_list' and find the
214- corresponding .ABOUT files in the 'input_path' and generate the output in
215- the 'output_path'. Therefore, please make sure there are .ABOUT files under
216- the 'input_path'.
211+ This tool will look at the components in the 'component_list' and find the
212+ corresponding .ABOUT files in the 'input_path' and generate the output in
213+ the 'output_path'. Therefore, please make sure there are .ABOUT files under
214+ the 'input_path'.
217215
218- Assuming the follow:
219- '/home/about_files/' contains all the ABOUT files from the component_list
220- '/home/attribution/attribution.html' is the user's output path
221- '/home/project/component_list.csv' is the component list that user want to be generated
216+ Assuming the follow:
217+ '/home/about_files/' contains all the ABOUT files from the component_list
218+ '/home/attribution/attribution.html' is the user's output path
219+ '/home/project/component_list.csv' is the component list that user want to be generated
222220
223- $ python genattrib.py /home/about_files/ /home/attribution/attribution.html /home/project/component_list.csv
221+ $ python genattrib.py /home/about_files/ /home/attribution/attribution.html /home/project/component_list.csv
224222
225223Options
226224-------
225+ --template_location
227226
228- --template_location
229-
230- This option allows you to use your own template for Attribution Generation.
231- For instance, if the custom template you want to use is located at:
232- /home/custom_template/template.html
227+ This option allows you to use your own template for Attribution Generation.
228+ For instance, if the custom template you want to use is located at:
229+ /home/custom_template/template.html
233230
234- $ python genattrib.py --template_location=/home/custom_template/template.html input_path output_path component_list
231+ $ python genattrib.py --template_location=/home/custom_template/template.html input_path output_path component_list
235232
236233
0 commit comments