dsi-cocoa 0.0.9

Clinic Opinionated Codebase Oversight and Analysis

Clinic Opinionated Codebase Oversight and Analysis

This repository was developed in order to generate automated reports on how well codebases adhere to the coding standards of the University of Chicago's DSI Clinic course.

The goals of this codebase is to provide a quick and easy way to review code and to alert contributors where their code may be failing.

Installation

pip install cocoa

cocoa

This package contains a module evaluate_repo which runs code testing libraries against a repository.

How to run

Via command line:

cocoa /path/to/repo

As a python module:

from cocoa.evaluate_repo import main

main(["path/to/repo"])

A few important notes:

1. Make sure to git pull before running this code.
2. This will get branch information for all branches.
3. This will only run the analysis (pyflakes on python files) for the code in the current branch. So if you run this while your current branch is main it will run on main.

If you want to do a full linting, then you can add the argument "LINT" to the run-code-analysis command, such as:

cocoa /path-to-repo LINT