Closed ntoxeg closed 3 years ago
Rebased
@ngeiswei review please.
Since I’m adding formatting changes on top of the CI setup, I’ve included the devcontainer setup as well - it doesn’t change anything for anyone not using it but can be nice for new users (and I could finally stop awkwardly throwing these file around without adding them to the repository).
As for the Makefile, it’s not necessary - it just comes from the nbdev
template. For now most of its functionality is not relevant (like generating documentation), so I can remove it if you wish. If black
is to be used though you can now use it to conveniently generate code from notebooks and format it at the same time.
As for the formatting, it’s your call @ngeiswei - I can revert it and just fix the missing newline manually (which will have to be done every time code from notebooks is generated until the Issue I posted is resolved in nbdev
). One important change now is that everyone will have to format the code with black
, so if you don’t like the idea of enforcing that I can drop it.
All seems to function, I'm merging. Thanks again @ntoxeg !
So, this is a CI setup that I proposed in #25.
nbdev
is setup and used in CI to do sanity checks on notebooks (whether they are clean etc.)settings.ini
is used for general info about the package,setup.py
reads dependencies fromrequirements.txt
. Overall these files won’t require much changing from now on.pytest
for testing because it is very popular, easy to setup and it can even run tests from other frameworks (like nose).Maybe I will figure out how to run Gym / MineRL code - like getting to run the workflow as a normal user or some other way. Thus, for now checking if notebooks execute is disabled.