Command line utility for working with Bulk Data Storage System content, available at https://data.uspto.gov.
Java 7 or above. The ability to connect to the internet (for downloading Gradle when running the wrapper script)
gradlew assemble
Using gradle itself:
gradlew run -Dexec.args="{args}"
Using the zip or tar distribution, located under build\distributions, use the script in the extracted /bin directory:
./bulk-data-tools {args}
At this time, the only tool available is an XML spitter.
The splitter takes as input an "XML" file that is actually a series of concatenated XML files, and splits them into individual XML files. Some of USPTO Bulk products, such as Patent Grant Full Text Data/XML Version 4.5 ICE, come in this format (zipped).
When no {args} are provided, the splitter will read data from stdin and output the XML segments to a directory,
splitxml, relative to the location the application is run. To specify input other than stdin, provide an --in arg.
To specify a different output directory, provide an --out arg. Non-existent output directories will be created as needed.
Example: read from local XML file and output to default directory.
gradlew run -Dexec.args="--in /path/to/ipg150106.xml"
./bulk-data-tools --in /path/to/ipg150106.xml
Example: read from local ZIP file and output to specific local directory
gradlew run -Dexec.args="--in /path/to/ipg150106.zip --out /path/to/directory"
./bulk-data-tools --in /path/to/ipg150106.zip --out /path/to/directory
Example: show help usage
gradlew run -Dexec.args="--help"
./bulk-data-tools --help
Support URLs in --in flag to download directly from https://data.uspto.gov/
The United States Department of Commerce (DOC) GitHub project code is provided on an 'as is' basis and the user assumes responsibility for its use. DOC has relinquished control of the information and no longer has responsibility to protect the integrity, confidentiality, or availability of the information. Any claims against the Department of Commerce stemming from the use of its GitHub project will be governed by all applicable Federal law. Any reference to specific commercial products, processes, or services by service mark, trademark, manufacturer, or otherwise, does not constitute or imply their endorsement, recommendation or favoring by the Department of Commerce. The Department of Commerce seal and logo, or the seal and logo of a DOC bureau, shall not be used in any manner to imply endorsement of any commercial product or activity by DOC or the United States Government.