@@ -72,7 +72,11 @@ Then open a terminal or command prompt, extract the download if needed and run::
7272
7373USAGE
7474-----
75- The ABOUT tool command syntax is::
75+ The ABOUT tool command syntax is:
76+
77+ about.py
78+
79+ ::
7680
7781 Usage: about.py [options] input_path output_path
7882
@@ -97,6 +101,55 @@ In this example, the .ABOUT files in the directory /thirdparty_code/ will
97101be parsed and validated to collect the data they contain. The collected
98102information will be saved to the CSV file named "thirdparty_about.csv".
99103
104+ genabout.py
105+
106+ ::
107+
108+ Usage: genabout.py [options] input_path output_path
109+
110+ Input must be a CSV file
111+ Output must be a directory location where the ABOUT files should be generated
112+
113+
114+ Options:
115+ -h, --help Display help
116+ --version Display current version, license notice, and copyright notice
117+ --verbosity=VERBOSITY
118+ Print more or fewer verbose messages while processing ABOUT files
119+ 0 - Do not print any warning or error messages, just a total count (default)
120+ 1 - Print error messages
121+ 2 - Print error and warning messages
122+
123+ --action=ACTION Handle different behaviors if ABOUT files already existed
124+ 0 - Do nothing if ABOUT file existed (default)
125+ 1 - Overwrites the current ABOUT field value if existed
126+ 2 - Keep the current field value and only add the "new" field and field value
127+ 3 - Replace the ABOUT file with the current generation
128+
129+ --all_in_one Generate all the ABOUT files in the [output_path] without
130+ any project structure
131+
132+ --copy_license=COPY_LICENSE
133+ Copy the 'license_text_file' from the project to the generated location
134+ Project path - Project path
135+
136+ --license_text_location=LICENSE_TEXT_LOCATION
137+ Copy the 'license_text_file' from the directory to the generated location
138+ License path - License text files path
139+
140+ --mapping Configure the mapping key from the MAPPING.CONFIG
141+
142+ --extract_license=EXTRACT_LICENSE
143+ Extract License text and create <license_key>.LICENSE side-by-side
144+ with the .ABOUT from DJE License Library.
145+ api_url - URL to the DJE License Library
146+ api_username - The regular DJE username
147+ api_key - Hash attached to your username which is used to authenticate
148+ yourself in the API. Contact us to get the hash key.
149+
150+ Example syntax:
151+ genabout.py --extract_license --api_url='api_url' --api_username='api_username' --api_key='api_key'
152+
100153
101154HELP and SUPPORT
102155----------------
0 commit comments