Skip to content

Commit 2610320

Browse files
committed
Update the USAGE.rst and README.rst
1 parent 22beecd commit 2610320

File tree

2 files changed

+64
-57
lines changed

2 files changed

+64
-57
lines changed

README.rst

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -122,9 +122,6 @@ information will be saved to the CSV file named "thirdparty_about.csv".
122122
1 - Overwrites the current ABOUT field value if existed
123123
2 - Keep the current field value and only add the "new" field and field value
124124
3 - Replace the ABOUT file with the current generation
125-
126-
--all_in_one Generate all the ABOUT files in the [output_path] without
127-
any project structure
128125

129126
--copy_files=COPY_FILES
130127
Copy the '*_file' from the project to the generated location

USAGE.rst

Lines changed: 64 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,19 @@
11
about.py
22
========
33

4-
Syntax
5-
------
4+
**Syntax**
65

7-
Usage: about.py [options] input_path output_path
6+
::
87

9-
Input can be a file or directory.
10-
Output must be a file with a .csv extension.
8+
about.py [options] input_path output_path
9+
10+
- Input can be a file or directory.
11+
- Output must be a file with a .csv extension.
12+
13+
**Options:**
14+
15+
::
1116

12-
Options:
1317
-h, --help Display help
1418
--version Display current version, license notice, and copyright notice
1519
--overwrite Overwrites the output file if it exists
@@ -21,32 +25,36 @@ Syntax
2125

2226
Purpose
2327
-------
24-
25-
Extract information from the .ABOUT files and save it to the CSV file.
28+
Extract information from the .ABOUT files and save it to the CSV file.
2629

2730
Options
2831
-------
2932

33+
::
34+
3035
--overwrite
3136
3237
Overwrite the extracted data from .ABOUT files to the output location
3338

34-
$ python about.py --overwrite <input path> <output path>
39+
$ python about.py --overwrite <input path> <output path>
3540

3641

3742
genabout.py
3843
===========
3944

40-
Syntax
41-
------
45+
**Syntax**
46+
47+
::
4248

43-
Usage: genabout.py [options] input_path output_path
49+
genabout.py [options] input_path output_path
4450

45-
Input must be a CSV file
46-
Output must be a directory location where the ABOUT files should be generated
51+
- Input must be a CSV file
52+
- Output must be a directory location where the ABOUT files should be generated
4753

54+
**Options:**
55+
56+
::
4857

49-
Options:
5058
-h, --help Display help
5159
--version Display current version, license notice, and copyright notice
5260
--verbosity=VERBOSITY
@@ -61,9 +69,6 @@ Syntax
6169
2 - Keep the current field value and only add the "new" field and field value
6270
3 - Replace the ABOUT file with the current generation
6371

64-
--all_in_one Generate all the ABOUT files in the [output_path] without
65-
any project structure
66-
6772
--copy_files=COPY_FILES
6873
Copy the '*_file' from the project to the generated location
6974
Project path - Project path
@@ -87,24 +92,19 @@ Syntax
8792

8893
Purpose
8994
-------
90-
91-
Generate ABOUT files from the input CSV file to output location
95+
Generate ABOUT files from the input CSV file to output location.
9296

9397
Options
9498
-------
9599

100+
::
101+
96102
--action=ACTION
97103

98104
Handle different behaviors if ABOUT files already existed.
99105
For instance, replace the ABOUT files with the current generation
100106

101-
$ python genabout.py --action=3 <input path> <output path>
102-
103-
--all_in_one
104-
105-
Generate all the ABOUT files to the output location without any project structure
106-
107-
$ python genabout.py --all_in_one <input path> <output path>
107+
$ python genabout.py --action=3 <input path> <output path>
108108

109109
--copy_files
110110

@@ -119,7 +119,7 @@ Options
119119
'license_text_file' and 'notice_text_file' from
120120
/home/project/ to /home/about/
121121

122-
$ python genabout.py --copy_files=/home/project/ <input path> /home/about/
122+
$ python genabout.py --copy_files=/home/project/ <input path> /home/about/
123123

124124
--license_text_location
125125

@@ -131,7 +131,7 @@ Options
131131
/home/license/apache2.LICENSE
132132
/home/license/jquery.js.LICENSE
133133

134-
$ python genabout.py --license_text_location=/home/licenses/ <input path> <output path>
134+
$ python genabout.py --license_text_location=/home/licenses/ <input path> <output path>
135135

136136
--mapping
137137

@@ -158,7 +158,7 @@ Options
158158
In another word, users do not need to modify the keys name of the
159159
input manually but let the 'MAPPING.CONFIG' to do the keys mapping.
160160

161-
$ python genabout.py --mapping <input path> <output path>
161+
$ python genabout.py --mapping <input path> <output path>
162162

163163
--extract_license
164164

@@ -173,35 +173,37 @@ Options
173173
yourself in the API.
174174
(Please contact us to get the api_* value to use this feature)
175175

176-
genabout.py --extract_license --api_url='api_url' --api_username='api_username' --api_key='api_key' <input path> <output path>
176+
$ python genabout.py --extract_license --api_url='api_url' --api_username='api_username' --api_key='api_key' <input path> <output path>
177177

178178

179179
genattrib.py
180180
============
181181

182-
Syntax
183-
------
184-
Usage: genattrib.py [options] input_path output_path component_list
182+
**Syntax**
183+
184+
::
185185

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.
186+
genattrib.py [options] input_path output_path component_list
189187

188+
- Input can be a file or directory.
189+
- Output of rendered template must be a file (e.g. .html).
190+
- Component List must be a .csv file which has at least an "about_file" column.
190191

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
192+
**Options:**
193+
194+
::
195+
196+
-h, --help Display help
197+
--version Display current version, license notice, and copyright notice
198+
--overwrite Overwrites the output file if it exists
199+
--verbosity=VERBOSITY
196200
Print more or fewer verbose messages while processing ABOUT files
197201
0 - Do not print any warning or error messages, just a total count (default)
198202
1 - Print error messages
199203
2 - Print error and warning messages
200-
201-
--template_location=TEMPLATE_LOCATION
204+
--template_location=TEMPLATE_LOCATION
202205
Use the custom template for the Attribution Generation
203-
204-
--mapping Configure the mapping key from the MAPPING.CONFIG
206+
--mapping Configure the mapping key from the MAPPING.CONFIG
205207

206208
Purpose
207209
-------
@@ -214,20 +216,28 @@ the 'output_path'. Therefore, please make sure there are .ABOUT files under
214216
the 'input_path'.
215217

216218
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
219+
220+
::
221+
222+
'/home/about_files/'** contains all the ABOUT files from the component_list
223+
'/home/attribution/attribution.html' is the user's output path
224+
'/home/project/component_list.csv' is the component list that user want to be generated
225+
226+
::
220227

221228
$ python genattrib.py /home/about_files/ /home/attribution/attribution.html /home/project/component_list.csv
222229

223230
Options
224231
-------
225-
--template_location
226232

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
233+
::
234+
235+
--template_location
236+
237+
This option allows you to use your own template for Attribution Generation.
238+
For instance, if the custom template you want to use is located at:
239+
/home/custom_template/template.html
230240

231-
$ python genattrib.py --template_location=/home/custom_template/template.html input_path output_path component_list
241+
$ python genattrib.py --template_location=/home/custom_template/template.html input_path output_path component_list
232242

233243

0 commit comments

Comments
 (0)