search

SilverLabUCL / PySilverLabNWB

Python tools for working with Silver Lab data in the NWB2 format
MIT License
1 stars 0 forks source link

Create project template #3

Closed jonc125 closed 5 years ago

jonc125 commented 6 years ago

This structure is based on https://github.com/ionelmc/cookiecutter-pylibrary and allows us to test on multiple Python versions easily, on Travis & AppVeyor (Windows), with style checking, read-the-docs integration, etc.

jonc125 commented 5 years ago

Finally got our dependencies installed OK on all 3 OSes, so this is probably worth merging before we add real code in a new PR. Could you sanity-check @ageorgou ?

codecov-io commented 5 years ago

Codecov Report

:exclamation: No coverage uploaded for pull request base (master@bfe1725). Click here to learn what that means. The diff coverage is 76.92%.

Impacted file tree graph

@@            Coverage Diff            @@
##             master       #3   +/-   ##
=========================================
  Coverage          ?   76.92%           
=========================================
  Files             ?        4           
  Lines             ?       13           
  Branches          ?        1           
=========================================
  Hits              ?       10           
  Misses            ?        3           
  Partials          ?        0
Impacted Files Coverage Δ
src/silverlabnwb/__main__.py 0% <0%> (ø)
src/silverlabnwb/__init__.py 100% <100%> (ø)
tests/test_silverlabnwb.py 100% <100%> (ø)
src/silverlabnwb/cli.py 100% <100%> (ø)

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 bfe1725...334af6d. Read the comment docs.

jonc125 commented 5 years ago

@ageorgou I think I've now responded to all your points, and I've also enabled the project properly on readthedocs and codecov.

ageorgou commented 5 years ago

I still don't completely understand whether we need ci/appveyor-download.py and ci/appveyor-with-compiler.cmd, but the rest looks good (assuming the latest AppVeyor build succeeds!)

jonc125 commented 5 years ago

I think the download script is to help you download anything AppVeyor builds for you, which may be helpful in the future. Similarly we may not need the compiler wrapper, but I'm not sure yet so have left it in.