Metadata-Version: 2.1
Name: dsi-cocoa
Version: 0.0.9
Summary: Clinic Opinionated Codebase Oversight and Analysis
Author-email: Nick Ross <tspread@uchicago.edu>, Trevor Spreadbury <tspread@uchicago.edu>
Maintainer: Nick Ross, Trevor Spreadbury
Keywords: codebase analysis,uchicago dsi
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Requires-Dist: GitPython
Requires-Dist: pyflakes
Requires-Dist: pylint
Requires-Dist: nbconvert
Requires-Dist: ipython
Requires-Dist: termcolor
Requires-Dist: black

# 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](https://github.com/dsi-clinic/coding-standards) of the University of Chicago's DSI [Clinic course](https://datascience.uchicago.edu/education/data-science-clinic/).

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: 
```bash
cocoa /path/to/repo
```

As a python module: 
```python
from cocoa.evaluate_repo import main

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

A few important notes:

1. Make sure to `git pull` _before_ running this code.
1. This will get branch information for all branches.
1. 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```
