Merge pull request #120 from openzim/clean_up

Clean up

Author: rgaudin

.flake8

@@ -0,0 +1,2 @@
+[flake8]
+max-line-length = 88

.github/workflows/test.yml

@@ -5,7 +5,6 @@ env:
   LIBZIM_VERSION: 2021-10-05
   LIBZIM_INCLUDE_PATH: include/zim
   CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
-  MAX_LINE_LENGTH: 88
   PROFILE: 1
 
 jobs:
@@ -20,18 +19,11 @@ jobs:
           python-version: 3.6
           architecture: x64
 
-      - name: Autoformat with black
+      - name: Check formatting and linting
         run: |
-          pip install black
-          black --check .
-
-      - name: Lint with flake8
-        run: |
-          pip install flake8
-          # one pass for show-stopper syntax errors or undefined names
-          flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-          # one pass for small stylistic things
-          flake8 . --count --max-line-length=$MAX_LINE_LENGTH --statistics
+          pip install -U invoke
+          invoke install-dev
+          invoke check
 
   test:
     runs-on: ${{ matrix.os }}

.gitignore

@@ -8,6 +8,8 @@ __pycache__
 .tox
 .coverage
 coverage.*
+*.swp
+
 
 # Compiled binaries and package builds
 *.so

CONTRIBUTING.md

@@ -30,14 +30,14 @@ pipenv run pip install -e .
 ### Run Linters & Tests
 
 ```bash
-# Autoformat code with black
-black --exclude=setup.py .
-# Lint and check for errors with flake8
-flake8 --exclude=setup.py .
+# Check format and linting
+invoke check
+# Autoformat and import sorting
+invoke lint
 # Typecheck with mypy (optional)
 mypy .
 # Run tests
-pytest .
+invoke test
 ```
 
 ### Rebuild Cython extension during development

examples/basic_writer.py

@@ -20,7 +20,7 @@
 import uuid
 
 from libzim.reader import Archive
-from libzim.writer import Item, StringProvider, Creator
+from libzim.writer import Creator, Item, StringProvider
 
 
 class TestItem(Item):

libzim/libzim.pyx

@@ -31,27 +31,28 @@ __path__ = []
 
 cimport zim
 
-import os
+import datetime
 import enum
+import importlib
+import importlib.abc
+import os
+import pathlib
+import sys
+import traceback
+from types import ModuleType
+from typing import Dict, Generator, Iterator, List, Set, Union
 from uuid import UUID
-from cpython.ref cimport PyObject
+
 from cpython.buffer cimport PyBUF_WRITABLE
+from cpython.ref cimport PyObject
 from cython.operator import preincrement
 from libc.stdint cimport uint64_t
-from libcpp.string cimport string
 from libcpp cimport bool
-from libcpp.memory cimport shared_ptr
 from libcpp.map cimport map
+from libcpp.memory cimport shared_ptr
+from libcpp.string cimport string
 from libcpp.utility cimport move
 
-from typing import Dict, Union, Generator, List, Set, Iterator
-import datetime
-import pathlib
-import traceback
-from types import ModuleType
-import sys
-import importlib.abc
-
 pybool = type(True)
 pyint = type(1)
 

libzim/zim.pxd

@@ -18,13 +18,12 @@
 # along with this program. If not, see <http://www.gnu.org/licenses/>.
 
 from cpython.ref cimport PyObject
-
 from libc.stdint cimport uint32_t, uint64_t
 from libcpp cimport bool
+from libcpp.map cimport map
 from libcpp.memory cimport shared_ptr
 from libcpp.string cimport string
 from libcpp.vector cimport vector
-from libcpp.map cimport map
 
 
 cdef extern from "zim/zim.h" namespace "zim":

pyproject.toml

@@ -4,3 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [tool.black]
 target-version = ['py36', 'py37', 'py38']
+
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

rebuild.sh

@@ -0,0 +1,8 @@
+isort>=5.9,<6.0
+black>=21.9b0,<22.0
+flake8>=3.9,<4.0
+invoke>=1.5,<2.0
+coverage>=5.0,<7.0
+pytest>=6.2,<7.0
+pytest-cov>=2.10,<4.0
+Cython>=0.29.24