thoth-station / template-project

This is a Template for any Python based project

template-project

This is a Template for any Python based project, it contains what Project Thoth and the AI CoE need:

1. GitHub defaults and Templates for issues.
2. Configuration for Coala and Black (code formating) are done using prow with pre-commit and mypy.
3. Zuul is no longer suppported. Instead AICOE-CI is used for basic configuration.
4. We have a public service configuration now accessible for everyone.
5. If you are writing a Python module, Kebechet could manage the releases of your packages for you.
6. If credentials are provided, Python module releases could be published to PyPI by Kebechet.

Dependencies should be managed using pipenv (Pipfile, and the Pipfile.lock could be created by thamos advise), pip3 and a requirements.txt files could be used.

template-project's Issues

More options for `This should yield a new module release`

template-project/.github/PULL_REQUEST_TEMPLATE.md

Line 19 in 122ec4e

<!-- If this change modifies the behavior of the module, specify that it should yield a new minor release. -->

Is the requirement for automation reasons or just a reference for repository maintainers? Nevertheless, wouldn't it be better to also include something like:

<!-- If this change modifies the behavior of the module, leave one of the following options -->
- patch
- minor
- major

?

shouldnt this be rhel?

template-project/.thoth.yaml

Lines 7 to 9 in 552764f

	operating_system:
	name: ubi
	version: "8"

No dependency management found for the ubi8 environment

No dependency management found for the ubi8 environment. If you want
to keep your dependencies managed, please submit Pipfile or requirements.in or requirements-dev.in file.

To generate a Pipfile, use:

$ pipenv install --skip-lock --code ./
$ git add Pipfile
$ git commit -m 'Add Pipfile for dependency management'

Make sure your Pipfile or requirements.in or requirements-dev.in is placed in the root of your Git repository.

/kind feature
/priority important-soon

No dependency management found

No dependency management found for this repository. If you want to keep your dependencies managed, please submit Pipfile or requirements.in or requirements-dev.in file.

To generate a Pipfile, use:

$ pipenv install --skip-lock --code ./
$ git add Pipfile
$ git commit -m 'Add Pipfile for dependency management'

Make sure your Pipfile or requirements.in or requirements-dev.in is placed in the root of your Git repository.

No dependency management found for the ubi8 environment

No dependency management found for the ubi8 environment. If you want
to keep your dependencies managed, please submit Pipfile or requirements.in or requirements-dev.in file.

To generate a Pipfile, use:

$ pip install --upgrade --user thamos
$ thamos discover --src-path ./
$ git add Pipfile
$ git commit -m 'Add Pipfile for dependency management'

Make sure your Pipfile or requirements.in or requirements-dev.in is placed in the root of your Git repository.

/kind feature
/priority important-soon

pre-commit is having duplicate configuration entries

Describe the bug

pre-commit has duplicate pre-commit entries.

See for example thoth-station/thamos#790 that addressed a similar issue.

update readme for the template

No dependency management found

No dependency management found for this repository. If you want to keep your dependencies managed, please submit Pipfile or requirements.in or requirements-dev.in file.

To generate a Pipfile, use:

$ pipenv install --skip-lock --code ./
$ git add Pipfile
$ git commit -m 'Add Pipfile for dependency management'

Make sure your Pipfile or requirements.in or requirements-dev.in is placed in the root of your Git repository.

`pre-commit` configuration and maintanance throughout `thoth-station`

Problem 1
pre-commit configuration tends to have different forms and norms throughout the projects in thoth-station
Sometimes it is not clear what kind of hooks should repository have and which should be avoided.

P1 Proposal 1
Create standard document with directions on which hooks should maintainer enable/disable according to the project specification and its needs.

P1 Proposal 2
Add all of the possible default hooks to the template project pre-commit configuration file with comments and description similar to those in the standard document. Maintainer can just ignore all of the hooks repository does not need

Problem 2
Right now, the pre-commit-config.yaml is left to be maintained by manual update of repository maintainers.

P2 Proposal
Consider adding new pre-commit update manager to https://github.com/thoth-station/kebechet/tree/master/kebechet/managers that would handle the issue the same as update manager (or possibly make it a part of the update manager).

/kind question
@thoth-station/devs

No dependency management found

No dependency management found for this repository. If you want to keep your dependencies managed, please submit Pipfile or requirements.in or requirements-dev.in file.

To generate a Pipfile, use:

$ pipenv install --skip-lock --code ./
$ git add Pipfile
$ git commit -m 'Add Pipfile for dependency management'

Make sure your Pipfile or requirements.in or requirements-dev.in is placed in the root of your Git repository.

Add `LOGS` section to the bug_report template

template-project/.github/ISSUE_TEMPLATE/bug_report.md

Line 26 in 122ec4e

### Additional context

I think that the LOGS section is something that would be more useful (compared to other sections like Additional Context which imo are not really used that often)

"

template-project/pyproject.toml

Lines 2 to 7 in c1e52a3

	name = "TODO"
	description = "TODO"
	readme = "README.rst"
	requires-python = ">=3.8"
	license = {file = "LICENSE"}

---

This issue was generated by todo based on a TODO comment in c1e52a3. It's been assigned to @goern because they committed the code.

Implement a pre-commit hook that checks for Pipfile/requirements.txt consistency

Is your feature request related to a problem? Please describe.

To avoid issues like this one:

thoth-station/adviser#1572 (comment)
thoth-station/storages#2101

we could develop a pre-commit hook that checks the consistency of these two files. Meaning - requirements in requirements.txt and Pipfile match.

Describe the solution you'd like

Develop a pre-commit hook to check the consistency of requirements.txt and Pipifle.

Describe alternatives you've considered

We have a bot for this - see https://github.com/thoth-station/kebechet/tree/master/kebechet/managers/pipfile_requirements This however, does not work well on PRs. It's more natural to gatet these type of errors in the CI on pull requests. The core logic of kebechet manager can be reused.

No dependency management found

No dependency management found for this repository. If you want to keep your dependencies managed, please submit Pipfile or requirements.in or requirements-dev.in file.

To generate a Pipfile, use:"

$ pipenv install --skip-lock --code ./
$ git add Pipfile
$ git commit -m 'Add Pipfile for dependency management'

Make sure your Pipfile or requirements.in or requirements-dev.in is placed in the root of your Git repository.

No dependency management found for the ubi8 environment

No dependency management found for the ubi8 environment. If you want
to keep your dependencies managed, please submit Pipfile or requirements.in or requirements-dev.in file.

To generate a Pipfile, use:

$ pip install --upgrade --user thamos
$ thamos discover --src-path ./
$ git add Pipfile
$ git commit -m 'Add Pipfile for dependency management'

Make sure your Pipfile or requirements.in or requirements-dev.in is placed in the root of your Git repository.

/kind feature
/priority important-soon