Metadata-Version: 2.1
Name: NREL-osos
Version: 0.0.2
Summary: Open Source Ops and Statistics
Home-page: https://nrel.github.io/osos/
Author: Grant Buster
Author-email: grant.buster@nrel.gov
License: BSD 3-Clause
Keywords: osos
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.7
Requires-Dist: click
Requires-Dist: nrel-rex
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: pypistats
Requires-Dist: requests
Provides-Extra: dev
Requires-Dist: pytest (>=5.2) ; extra == 'dev'
Requires-Dist: flake8 ; extra == 'dev'
Requires-Dist: pre-commit ; extra == 'dev'
Requires-Dist: pylint ; extra == 'dev'
Provides-Extra: test
Requires-Dist: pytest (>=5.2) ; extra == 'test'

*************************************
Open Source Ops and Statistics (OSOS)
*************************************

.. image:: https://github.com/NREL/osos/workflows/Documentation/badge.svg
    :target: https://nrel.github.io/osos/

.. image:: https://github.com/NREL/osos/workflows/pytests/badge.svg
    :target: https://github.com/NREL/osos/actions?query=workflow%3A%22pytests%22

.. image:: https://github.com/NREL/osos/workflows/Lint%20Code%20Base/badge.svg
    :target: https://github.com/NREL/osos/actions?query=workflow%3A%22Lint+Code+Base%22

.. image:: https://img.shields.io/pypi/pyversions/NREL-osos.svg
    :target: https://pypi.org/project/NREL-osos/

.. image:: https://badge.fury.io/py/NREL-osos.svg
    :target: https://badge.fury.io/py/NREL-osos

.. image:: https://img.shields.io/github/license/NREL/osos
    :target: https://github.com/NREL/osos/blob/main/LICENSE

.. image:: https://codecov.io/gh/NREL/osos/branch/main/graph/badge.svg?token=0J5GVFEGYZ
   :target: https://codecov.io/gh/NREL/osos


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 <https://nrel.github.io/osos/_cli/osos.html#osos>`_
for details on how to run OSOS from the command line.


Installing OSOS
===============

OSOS can be installed via pip: ``pip install nrel-osos``. After installing, try
calling the command line help page with ``osos --help`` to make sure the
installation worked.


