Using the application¶
Spices is divided in several commands.
spices pypi¶
This command generates a JSON module index with information from PyPI. Read below for more information on how to use it:
$ spices pypi --help
usage: spices pypi [options]
General Options:
-V, --version Print version and exit.
-h, --help Show this help message and exit.
Pypi Options:
-l <level>, --loglevel <level>
Logger verbosity level (default: INFO). Must be one
of: DEBUG, INFO, WARNING, ERROR or CRITICAL.
-f <path>, --logfile <path>
A path pointing to a file to be used to store logs.
-o <path>, --outputfile <path>
A path pointing to a file that will be used to store
the JSON Module Index (required).
-R <letter/number>, --letter-range <letter/number>
An expression representing an alphanumeric range to be
used to filter packages from PyPI (default: 0-z). You
can use a single alphanumeric character like "0" to
process only packages beginning with "0". You can use
commas use as a list o dashes to use as an interval.
-L <size>, --limit-log-size <size>
Stop processing if log size exceeds <size> (default:
3M).
-M <size>, --limit-mem <size>
Stop processing if process memory exceeds <size>
(default: 2G).
-T <sec>, --limit-time <sec>
Stop processing if process time exceeds <sec>
(default: 2100).
spices stdlib¶
This command generates a JSON Module Index from the Python Standard Library. Read below for more information on how to use it:
$ spices stdlib --help
usage: spices stdlib [options]
General Options:
-V, --version Print version and exit.
-h, --help Show this help message and exit.
Stdlib Options:
-o <path>, --outputfile <path>
A path pointing to a file that will be used to store
the JSON Module Index (required).
-p <version>, --pyver <version>
Python version to be used for the Standard Library
(default: 2.7).
spices stats¶
This command gathers statistics from the logs generated by the pypi
command. Read below for more information on how to use it:
$ spices stats --help
usage: spices stats [options]
General Options:
-V, --version Print version and exit.
-h, --help Show this help message and exit.
Stats Options:
-i <path>, --inputdir <path>
A path pointing to a directory containing JSON files
generated by the pypi command (required).
-o <path>, --outputfile <path>
A path pointing to a file that will be used to store
the statistics (required).
spices errors¶
This command summarizes errors found in the logs generated by the pypi
command. Read below for more information on how to use it:
$ spices errors --help
usage: spices errors [options]
General Options:
-V, --version Print version and exit.
-h, --help Show this help message and exit.
Errors Options:
-i <path>, --inputdir <path>
A path pointing to a directory containing JSON files
generated by the pypi command (required).
-o <path>, --outputfile <path>
A path pointing to a file that will be used to store
the errors (required).
spices merge¶
This command searches for JSON files generated by the pypi
or stdlib
commands and combines them into one. Read below for more information on how to
use it:
$ spices merge --help
usage: spices merge [options]
General Options:
-V, --version Print version and exit.
-h, --help Show this help message and exit.
Merge Options:
-i <path>, --inputdir <path>
A path pointing to a directory containing JSON files
generated by pypi or stdlib commands (required).
-o <path>, --outputfile <path>
A path pointing to a file that will be used to store
the merged JSON files (required).