Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Include CI from Python Package Skeleton Template #21

Open
1 task done
Ludee opened this issue Feb 9, 2023 · 2 comments · Fixed by #55
Open
1 task done

Include CI from Python Package Skeleton Template #21

Ludee opened this issue Feb 9, 2023 · 2 comments · Fixed by #55
Assignees
Labels
other: help wanted 🙋 Help or assistance is needed part: backend 🧱 Backend component priority: critical 🔥 Critical priority status: discussion 💬 Discussion is ongoing type: feature 🛠️ New feature or request

Comments

@Ludee
Copy link
Member

Ludee commented Feb 9, 2023

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

@Ludee Ludee added the type: enhancement ⚙️ Improvement of an existing feature label Feb 9, 2023
@Ludee Ludee added this to the Complete repository milestone Feb 9, 2023
@Ludee Ludee assigned Ludee and jh-RLI Feb 9, 2023
@jh-RLI
Copy link
Contributor

jh-RLI commented Aug 16, 2023

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 added a commit that referenced this issue Aug 16, 2023
jh-RLI added a commit that referenced this issue Aug 16, 2023
also cnfigure te lint and test tools #21
add reuse identier #7
jh-RLI added a commit that referenced this issue Aug 16, 2023
jh-RLI added a commit that referenced this issue Aug 16, 2023
jh-RLI added a commit that referenced this issue Aug 16, 2023
jh-RLI added a commit that referenced this issue Aug 16, 2023
jh-RLI added a commit that referenced this issue Aug 16, 2023
jh-RLI added a commit that referenced this issue Aug 16, 2023
jh-RLI added a commit that referenced this issue Aug 16, 2023
jh-RLI added a commit that referenced this issue Aug 16, 2023
jh-RLI added a commit that referenced this issue Aug 16, 2023
…ore list (tox.ini) as they are difficualt to handle when creting example docstrings #21
jh-RLI added a commit that referenced this issue Aug 17, 2023
@Ludee Ludee added other: help wanted 🙋 Help or assistance is needed part: backend 🧱 Backend component type: feature 🛠️ New feature or request and removed type: enhancement ⚙️ Improvement of an existing feature labels Aug 17, 2023
@Ludee Ludee added priority: critical 🔥 Critical priority status: discussion 💬 Discussion is ongoing labels Aug 17, 2023
jh-RLI added a commit that referenced this issue Aug 23, 2023
jh-RLI added a commit that referenced this issue Aug 23, 2023
jh-RLI added a commit that referenced this issue Aug 23, 2023
jh-RLI added a commit that referenced this issue Aug 23, 2023
jh-RLI added a commit that referenced this issue Aug 23, 2023
Ludee added a commit that referenced this issue Aug 24, 2023
Ludee added a commit that referenced this issue Aug 24, 2023
Ludee added a commit that referenced this issue Aug 24, 2023
Ludee added a commit that referenced this issue Aug 24, 2023
Ludee added a commit that referenced this issue Aug 24, 2023
@jh-RLI
Copy link
Contributor

jh-RLI commented Aug 24, 2023

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
other: help wanted 🙋 Help or assistance is needed part: backend 🧱 Backend component priority: critical 🔥 Critical priority status: discussion 💬 Discussion is ongoing type: feature 🛠️ New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants