zifn / CS289_Coltrims_ML

repo for the final project of berkeley CS289
0 stars 1 forks source link

Ci and lint #3

Closed zifn closed 4 years ago

zifn commented 4 years ago

This PR addresses Issue #1 and #2 by adding needed config files for Travis CI and pylint as well as providing integration for code coverage verification. This PR also modifies the gitignore file to allow for private information to be stored in the "privileged" directory.

The pylint config file was taken from the adafruit's linter used for code examples, link. Travis CI will run the linter, pytest files of the form test_.py, and a code coverage analysis. If these tests pass it will then ask the Codecov site to check and format the code coverage report.

codecov[bot] commented 4 years ago

Codecov Report

:exclamation: No coverage uploaded for pull request base (main@9c295c0). Click here to learn what that means. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff            @@
##             main        #3   +/-   ##
========================================
  Coverage        ?   100.00%           
========================================
  Files           ?         1           
  Lines           ?         2           
  Branches        ?         0           
========================================
  Hits            ?         2           
  Misses          ?         0           
  Partials        ?         0           

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 9c295c0...3344adf. Read the comment docs.

zifn commented 4 years ago

Initial tests pass so Travis Ci is set up with the pylint linter, pytest for running tests, pytest-cov for checking the test coverage. and the codecov integration used to generate reports of the code coverage. Details may be subject to change as the project progresses.