From 6685b898f8d8d8d70b1b8d98f3b27073dfb4bfe9 Mon Sep 17 00:00:00 2001 From: Romain Failliot Date: Wed, 24 Nov 2021 20:39:00 -0500 Subject: [PATCH] Created a requirements.dev.txt just for the developers --- .github/workflows/ci.yml | 2 +- CHANGELOG.md | 1 + docs/developers.md | 14 ++++++++++---- requirements.dev.txt | 4 ++++ requirements.txt | 3 --- 5 files changed, 16 insertions(+), 8 deletions(-) create mode 100644 requirements.dev.txt diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 5451de4..32b37b1 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -22,7 +22,7 @@ jobs: - name: Install dependencies run: | sudo apt-get -y install libgirepository1.0-dev appstream appstream-util desktop-file-utils gettext - pip install -r requirements.txt + pip install -r requirements.dev.txt - name: Meson build uses: BSFishy/meson-build@v1.0.3 diff --git a/CHANGELOG.md b/CHANGELOG.md index 1f253eb..c3d733f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -27,6 +27,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Added linters (flake8 and mypy) and fixed some errors - Added lint jobs for both in the CI - Added a flatpak job in the CI +- Created a requirements.dev.txt just for the developers ### Changed - main.py slimmed down by about 5000 lines diff --git a/docs/developers.md b/docs/developers.md index 4f7c16e..6cfb078 100644 --- a/docs/developers.md +++ b/docs/developers.md @@ -2,11 +2,17 @@ ## Requirements -Diffuse is implemented in Python and should run on any platform with Python and -PyGObject. +To install the requirements just to execute the binary, run: -* Python >= 3.4 -* PyGObject >= 3.18 +```sh +pip install -r requirements.txt +``` + +For developer tools, run this one instead (it includes requirements.txt): + +```sh +pip install -r requirements.dev.txt +``` ## Setup on Linux diff --git a/requirements.dev.txt b/requirements.dev.txt new file mode 100644 index 0000000..fc0cf07 --- /dev/null +++ b/requirements.dev.txt @@ -0,0 +1,4 @@ +-r requirements.txt +flake8 ~= 3.8 +flake8-noqa ~= 1.2 +mypy ~= 0.910 diff --git a/requirements.txt b/requirements.txt index 548d969..589e03c 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1 @@ -flake8 ~= 3.8 -flake8-noqa ~= 1.2 -mypy ~= 0.910 PyGObject ~= 3.40