OSL Repo Extractor

The extraction stage of the NAU-OSL project pipeline.

Purpose

The GitHub Repo Extractor provides an expedient way to gather data from GitHub repositories using the GitHub REST API. See the documentation for more information.

Requirements

• Written in Python 3.8.3
• Install library dependencies via requirments.txt or manually
  • pip install -r requirements.txt
  • Packages:
    • PyGithub
      • pip install pygithub
    • Cerberus
      • pip install cerberus

Contributing

commit formatting

• Please abide by the "Conventional Commits" specification for all commits

source code standards

Using default settings for each, please:

• format all contributions with black
  • pip install black
• lint all contributions with pylint
  • pip install pylint