refactor: Link project requirements.txt's to root requirements.txt#4396
refactor: Link project requirements.txt's to root requirements.txt#4396Laennart wants to merge 4 commits into
Conversation
|
There was a problem hiding this comment.
Pull request overview
This PR consolidates Python dependency installation by making the repository’s top-level requirements.txt the single entry point, and updating workflows/docs accordingly.
Changes:
- Expand root
requirements.txtto include linting tools and-rinclude the importer and app-data-import requirements files. - Remove the dedicated
requirements-for-app-data-import.txtand introduce/adjust per-component requirements files with notes pointing to the root. - Update GitHub Actions and documentation to install from the root
requirements.txt.
Reviewed changes
Copilot reviewed 6 out of 7 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| scripts/customizing/app_data_import/requirements.txt | Adds an app-data-import requirements file intended to be pulled in by the root requirements. |
| scripts/customizing/app_data_import/requirements-for-app-data-import.txt | Removes the old app-data-import requirements file. |
| scripts/customizing/app_data_import/readme.md | Adds installation instructions pointing to the top-level requirements. |
| roles/importer/files/importer/requirements.txt | Adds a note about using root requirements and removes linting deps from this file. |
| requirements.txt | Becomes the main dependency entry point; adds linting deps and includes other requirements via -r. |
| documentation/importer/readme.md | Updates lint setup instructions to install from root requirements. |
| .github/workflows/test-install.yml | Updates CI to install from root requirements in the python-code-check job. |
Comments suppressed due to low confidence (1)
scripts/customizing/app_data_import/requirements-for-app-data-import.txt:1
- This file is removed, but
documentation/developer-docs/git-howto.mdstill instructs installing it alongside the importer requirements. Please update that documentation (or provide a compatibility stub/redirect) so new contributors don’t follow broken setup steps.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| Make sure to install the required Python packages from the top-level `requirements.txt` (GitPython is required to fetch the CSV files from Git): | ||
|
|
||
| ```bash | ||
| pip install -r requirements.txt |
| @@ -0,0 +1,3 @@ | |||
| # NOTE: Install all dependencies by using the top-level requirements.txt | |||
|
|
|||
| GitPython>=3.1.0 | |||
| ruff and pre-commit are in requirements.txt | ||
|
|
||
| ``` | ||
| pip install -r .\roles\importer\files\importer\requirements.txt | ||
| pip install -r requirements.txt | ||
| ``` |
tpurschke
left a comment
tpurschke
left a comment
There was a problem hiding this comment.
let's discuss today if we should really fix the versions with == instead of using >=
From a security standpoint this is not really ideal.
Ah I did not see this. I just merged #4634 which fixes the versions and adds dependabot for python packages. We can change this again with another PR should we decide on a different approach |
Consolidates all used dependencies in the top-level requirements.txt