search

rl-institut / super-repo

A template repo to test and document repo elements and features
https://rl-institut.github.io/super-repo/
MIT License
13 stars 0 forks source link

Include CI from Python Package Skeleton Template #21

Open Ludee opened 1 year ago

Ludee commented 1 year ago

Description of the issue

I just found an existing repo template that has well documented CI structures. https://github.com/joaomcteixeira/python-project-skeleton

Ideas of solution

Merge or import the features. Give proper attribution.

Workflow checklist

jh-RLI commented 1 year ago

The CI structure documented in the repo is good, but it uses tox, which might be overkill for many smaller projects. In this case, I suggest to just use pytest. Tox is good for running tests in multiple environments (for multiple Python versions) and also for setting up the infrastructure first to run integration tests (tests that check functions that depend on other functions/services).

In any case, to demonstrate the basic TDD workflow to beginners, it is better to start without Tox. With pytest you can implement tests that fail without any overhead. Then the functionality is implemented and the test is executed again until all tests pass successfully.

[Edit] I will just implement it using tox ... we can still create a guide that uses pytest.

jh-RLI commented 1 year ago

For some reason this was not closed after the merge. Do you want to keep this issue open? @Ludee