Implement github actions

[SabineHaas]

Fix #6

Changes proposed in this PR:

• Add github actions workflow including:
  • run tests with pytest
  • add test coverage
  • check linting with black
• Remove test_requirements.txt and add extras_require to setup.py

The checks are done for python 3.7 and 3.8 currently, this can be adapted of course.

[SabineHaas]

@jnnr and @juliusmeier you can lint your code with Black (run black . --exclude docs/). The CI will remind you to do so, as the build will fail if the code is not linted with black, as soon as #25 is merged.

You can install the extra requirements with dev option via pip install -e .[dev] assuming you navigated to the directory where setup.py is located.

@jnnr this PR should be merged soon to prevent merge conflicts due to the code linting.
I can add the same workflow to oemoflex after your review.

[jnnr]

@jnnr and @juliusmeier you can lint your code with Black (run black . --exclude docs/). The CI will remind you to do so, as the build will fail if the code is not linted with black, as soon as #25 is merged.

How do you do it? Do you have black added to your pre-commit hook? update: Did so and am happy with it.

[jnnr]

Shall we use flake8 as well? I am for it. To prevent conflicts with black, some rules should be ignored. I found information [here] (https://ljvmiranda921.github.io/notebook/2018/06/21/precommits-using-black-and-flake8/) and in this recent oemof-solph PR oemof/oemof-solph#746.

[SabineHaas]

@jnnr and @juliusmeier you can lint your code with Black (run black . --exclude docs/). The CI will remind you to do so, as the build will fail if the code is not linted with black, as soon as #25 is merged.

How do you do it? Do you have black added to your pre-commit hook? update: Did so and am happy with it.

nice 👍 could you post here, how you did that?

If you've followed instructions from your above posted link I understand that this can be added to the repo, so that it is a setting for all of us..?!

Shall we use flake8 as well? I am for it. To prevent conflicts with black, some rules should be ignored. I found information [here] (https://ljvmiranda921.github.io/notebook/2018/06/21/precommits-using-black-and-flake8/) and in this recent oemof-solph PR oemof/oemof-solph#746.

Ah yes, I can add this.

[jnnr]

How do you do it? Do you have black added to your pre-commit hook? update: Did so and am happy with it.

nice +1 could you post here, how you did that?

I added a file named pre-commit (no extension) to my local git repo's .git/hooks. The file contains update: Added the --diff flag to prevent black from actually converting the files. Before commit, I just want a check. Otherwise, black changes the files, but these changes are not part of the commit. Maybe there is a more clever way to automatically add it and then commit?

#!/bin/sh
flake8 .
black . --diff --exclude /docs

Maybe the order matters?

Then, I made the file executable by chmod +x

Now, each time when I commit, the linters run first and stop the commit if there is mistake.

[SabineHaas]

How do you do it? Do you have black added to your pre-commit hook? update: Did so and am happy with it.

nice +1 could you post here, how you did that?

I added a file named pre-commit (no extension) to my local git repo's .git/hooks. The file contains:

#!/bin/sh
flake8 .
black . --exclude /docs

Maybe the order matters?

Then, I made the file executable by chmod +x

Now, each time when I commit, the linters run first and stop the commit if there is mistake.

Nice thank you! I guess you could even push that to the repo, so that we can use it, as well.

Now you can use black ., no need for --exclude, as I've added a config file for black, too.