osos

osos command line interface (CLI).

osos [OPTIONS] COMMAND [ARGS]...

Options

plot

Generate plots from all osos csv’s in the source_dir.

osos plot [OPTIONS]

Options

-m, --metric <metric>

Required Metric from the osos csv files to plot.

-y, --ylabel <ylabel>

Required Plot y-axis label, can include “{name}” which will get formatted with the repo name inferred from the osos data csv filename.

-so, --source_dir <source_dir>

Required Directory to look for osos .csv files. This function will try to plot the metric from all csv files in this directory.

-sa, --save_dir <save_dir>

Required Directory to save plots.

Retrieve repo usage data using osos

osos run [OPTIONS]

Options

-c, --config <config>: Path to .csv config file with columns for git_owner, git_repo, fpath_out, and (optionally) pypi_name, conda_org, and conda_name. Either input this for multiple osos jobs or all of the argument explicitly for a single osos job.

-go, --git_owner <git_owner>: Github repository owner, e.g. https://github.com/{git_owner}/{git_repo}. Case insensitive.

-gr, --git_repo <git_repo>: Github repository name, e.g. https://github.com/{git_owner}/{git_repo}. Case insensitive.

-pn, --pypi_name <pypi_name>: pypi package name. Note that this should include the prefix for nrel packages e.g. reV -> nrel-rev. This can be None if there is no pypi package. Case insensitive.

-co, --conda_org <conda_org>: Conda organization name, for example: https://anaconda.org/{org}/{name}. Case insensitive.

-cn, --conda_name <conda_name>: Conda package name, for example: https://anaconda.org/{org}/{name}. Case insensitive.

-f, --fpath_out <fpath_out>: Output file to save the osos output table. If the file exists, it will be updated with the latest data. This path can include the keywords “DATA_DIR” and “NAME” which will get replaced by the system location of the /osos/data/ directory and the github repo name, respectively.