NREL-osos 0.0.3

Open Source Ops and Statistics

This package helps track usage and contribution data for open source software. OSOS can be used to retrieve timeseries data on the usage and activity of open source repositories. Note that github usage data (clones and views) are only available for repositories that you have push permissions to, and they are only available for the last two weeks. Also note that OSOS needs a github API token stored in the environment variable GITHUB_TOKEN to pull data from github. See the OSOS CLI documentation for details on how to run OSOS from the command line.

Installing OSOS

OSOS can be installed via pip: pip install nrel-osos or by cloning the repo and doing a developer install: pip install -e . from within the repo directory.

Getting Started

After installing, try calling the command line help page with osos --help to see the run options. There are currently two CLI commands: one for running the osos utility (osos run --help) and one for plotting the osos data files (osos plot --help).

You can also run osos from python directly. Try launching binder and navigating to the osos example notebook. You will need your own github api token to run the notebook.

How To Use OSOS

OSOS is a general utility for downloading usage statistics from github, pypi, and conda. Feel free to fork the repo to track your own projects. We have a scheduled github action workflow set up to automatically pull usage statistics for our projects every Monday morning. The data is saved in the osos data directory and plots are saved to the osos plots directory. For example, here is the 180-day cumulative pypi downloads for reV, one of our open source projects: