Merge pull request #99 from FledgeXu/imporve

Better QA configuration

Author: rgaudin

.github/workflows/ci.yml

@@ -49,6 +49,6 @@ jobs:
         python -m pip install --upgrade pip
         pip install -U tox
     - name: Run tox
-      run: tox -e py38,black,coverage
+      run: tox -e py38,black,isort,flake8,coverage
       env:
         CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.gitignore

@@ -1,3 +1,55 @@
+# Created by https://www.toptal.com/developers/gitignore/api/python,macos,windows,linux
+# Edit at https://www.toptal.com/developers/gitignore?templates=python,macos,windows,linux
+
+### Linux ###
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### macOS Patch ###
+# iCloud generated files
+*.icloud
+
+### Python ###
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
@@ -20,7 +72,6 @@ parts/
 sdist/
 var/
 wheels/
-pip-wheel-metadata/
 share/python-wheels/
 *.egg-info/
 .installed.cfg
@@ -50,6 +101,7 @@ coverage.xml
 *.py,cover
 .hypothesis/
 .pytest_cache/
+cover/
 
 # Translations
 *.mo
@@ -72,6 +124,7 @@ instance/
 docs/_build/
 
 # PyBuilder
+.pybuilder/
 target/
 
 # Jupyter Notebook
@@ -82,7 +135,9 @@ profile_default/
 ipython_config.py
 
 # pyenv
-.python-version
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
 
 # pipenv
 #   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
@@ -91,7 +146,22 @@ ipython_config.py
 #   install all needed dependencies.
 #Pipfile.lock
 
-# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
 __pypackages__/
 
 # Celery stuff
@@ -127,3 +197,54 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+pyrightconfig.json
+
+### Windows ###
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+# End of https://www.toptal.com/developers/gitignore/api/python,macos,windows,linux

.pre-commit-config.yaml

@@ -2,21 +2,21 @@
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v3.2.0
+    rev: v4.4.0
     hooks:
     -   id: trailing-whitespace
     -   id: end-of-file-fixer
 -   repo: https://github.com/pycqa/isort
-    rev: "5.9.3"
+    rev: "5.12.0"
     hooks:
     -   id: isort
         args: ["--profile", "black", "--filter-files"]
 -   repo: https://github.com/psf/black
-    rev: "22.3.0"
+    rev: "23.1.0"
     hooks:
     -   id: black
--   repo: https://gitlab.com/pycqa/flake8
-    rev: "3.9.2"
+-   repo: https://github.com/pycqa/flake8
+    rev: "6.0.0"
     hooks:
     -   id: flake8
         args: ["--max-line-length", "88", "--extend-ignore=E203"]

README.md

@@ -45,6 +45,16 @@ sudo apt install libmagic1 wget ffmpeg \
     libharfbuzz-dev libfribidi-dev libxcb1-dev gifsicle
 ```
 
+# Contribution
+
+```shell
+pip -r requirements.txt
+pip install tox pre-commit
+pre-commit install
+# For tests
+tox
+```
+
 # Users
 
 Non-exhaustive list of scrapers using it (check status when updating API):

src/zimscraperlib/image/optimization.py

@@ -61,7 +61,6 @@ def optimize_png(
     background_color: Optional[Tuple[int, int, int]] = (255, 255, 255),
     **options,
 ) -> Union[pathlib.Path, io.BytesIO]:
-
     """method to optimize PNG files using a pure python external optimizer
 
     Arguments:
@@ -107,7 +106,6 @@ def optimize_jpeg(
     keep_exif: Optional[bool] = True,
     **options,
 ) -> Union[pathlib.Path, io.BytesIO]:
-
     """method to optimize JPEG files using a pure python external optimizer
     quality: JPEG quality (integer between 1 and 100)
         values: 50 | 55 | 35 | 100 | XX
@@ -155,7 +153,6 @@ def optimize_jpeg(
         dst.seek(0)
 
     if keep_exif and had_exif:
-
         piexif.transplant(
             exif_src=str(src.resolve())
             if isinstance(src, pathlib.Path)

tests/conftest.py

@@ -174,7 +174,6 @@ def real_zim_file(tmpdir_factory):
 
 @pytest.fixture(scope="session")
 def undecodable_byte_stream():
-
     return (
         b"\x00\x00\x00\x00\x00\x00\x80\x00\x00\x00\x00\x00\x00\x00\x00\x00"
         b"\x00\x00\x01\x00\xfb\xff~\x00\x08\x00\xfd\xff\x01\x00\x00\x00"

tests/filesystem/test_filesystem.py

@@ -25,7 +25,6 @@ def test_content_mimetype(png_image, jpg_image, undecodable_byte_stream):
 
 
 def test_content_mimetype_fallback(monkeypatch, undecodable_byte_stream):
-
     # use raw function first to test actual code
     assert get_content_mimetype(undecodable_byte_stream) == "application/octet-stream"
 

tests/logging/test_logging.py

@@ -80,7 +80,6 @@ def test_critical_level(random_id, console):
 
 
 def test_format():
-
     # assert is_in_log(message, console)
     # "[%(asctime)s] %(levelname)s:%(message)s"
     pass

tests/ogvjs/test_ogvjs.py

@@ -13,7 +13,6 @@
 
 
 def prepare_ogvjs_folder(tmp_path, videojs_url, ogvjs_url, videojs_ogvjs_url):
-
     videojs_zip = tmp_path / "video-js-7.6.4.zip"
     if not videojs_zip.exists():
         save_large_file(videojs_url, videojs_zip)

tox.ini

@@ -1,5 +1,5 @@
 [tox]
-envlist = py36, py37, py38, py39, py310, py311, black, coverage
+envlist = py36, py37, py38, py39, py310, py311, black, isort, flake8, coverage
 
 [testenv]
 passenv =
@@ -15,9 +15,19 @@ commands =
 
 [testenv:black]
 deps =
-    black>=22.3.0,<23
+    black>=23.1.0,<24
 commands = black --check .
 
+[testenv:isort]
+deps =
+    isort>=5.12.0,<5.13
+commands = isort --profile black --check src tests
+
+[testenv:flake8]
+deps =
+    flake8>=6.0.0,<7.0
+commands = flake8 src --count --max-line-length=88 --statistics --extend-ignore=E203
+
 [testenv:coverage]
 passenv =
     CODECOV_TOKEN