Merge pull request #168 from InsightLab/developer

Developer

Author: mxaviersmp

.code-style.md

@@ -20,6 +20,11 @@ We following the [Numpy](https://numpydoc.readthedocs.io/en/latest/format.html)
 
 ---
 
+## flake8
+
+Flake8 is a python linter that helps to keep the code up to PEP standards.
+To lint the code, run: `make lint`
+
 ## Pre-Commit
 
 Next we'll explain the steps to use the pre-commit hooks.

.documentation.md

@@ -82,7 +82,7 @@ and finish!
 To generate the .html files, just access the docs folder, just run the
 following command:
 
-`make html`
+`make doc`
 
 #### 2.4. Hospedando docs in [Readthedocs](https://readthedocs.org/)
 

.github/workflows/code_coverage.yml

@@ -17,8 +17,8 @@ jobs:
         python-version: 3.7
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade "pip<20"
-        pip install -r requirements-dev.txt
+        python -m pip install --upgrade pip
+        pip install pytest coverage geopandas .
     - name: Coverage
       run: |
         coverage run -m pytest

.github/workflows/lint_and_test.yml

@@ -13,8 +13,8 @@ jobs:
         python-version: 3.7
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade "pip<20"
-        pip install -r requirements-dev.txt
+        python -m pip install --upgrade pip
+        pip install flake8 pep8-naming .
     - name: Lint
       working-directory: ${{ github.workspace }}
       run: |
@@ -30,9 +30,9 @@ jobs:
         python-version: 3.7
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade "pip<20"
-        pip install -r requirements-dev.txt
+        python -m pip install --upgrade pip
+        pip install pytest geopandas .
     - name: Test
       working-directory: ${{ github.workspace }}
       run: |
-        pytest
+        pytest --verbose

.github/workflows/publish.yml

@@ -17,8 +17,8 @@ jobs:
         python-version: 3.7
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade "pip<20"
-        pip install -r requirements-dev.txt
+        python -m pip install --upgrade pip
+        pip install flake8 pep8-naming pytest geopandas .
     - name: Lint and Test
       run: |
         flake8

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v2.5.0
+    rev: v3.4.0
     hooks:
     -   id: double-quote-string-fixer
     -   id: trailing-whitespace
@@ -16,14 +16,14 @@ repos:
     - id: autoflake
       args: ['--in-place', '--remove-all-unused-imports', '--ignore-init-module-imports']
 -   repo: https://github.com/asottile/seed-isort-config
-    rev: v1.9.3
+    rev: v2.2.0
     hooks:
     - id: seed-isort-config
 -   repo: https://github.com/pre-commit/mirrors-isort
-    rev: v4.3.21
+    rev: v5.7.0
     hooks:
     - id: isort
 -   repo: https://gitlab.com/pycqa/flake8
-    rev: 3.7.9
+    rev: 3.8.4
     hooks:
     - id: flake8

Makefile

@@ -0,0 +1,28 @@
+help:
+	@echo "available commands"
+	@echo " - dev    : install dev environment"
+	@echo " - clean  : clean temporary folders and files"
+	@echo " - test   : runs all unit tests"
+	@echo " - lint   : checks code style"
+	@echo " - doc    : creates documentation in html"
+
+dev:
+	pip install -r requirements-dev.txt
+	pre-commit install
+
+clean:
+	rm -rf `find . -type d -name .pytest_cache`
+	rm -rf `find . -type d -name __pycache__`
+	rm -rf `find . -type d -name .ipynb_checkpoints`
+	rm -rf docs/_build
+	rm -f .coverage
+
+test: clean
+	coverage run -m pytest
+	coverage report
+
+lint: clean
+	flake8
+
+doc: clean
+	make -C docs html

README.md

@@ -208,7 +208,7 @@ Requirements: Anaconda Python distribution installed and accessible
     -   `git pull origin developer`
 
 5.  Install pymove in developer mode
-    -   `pip install -r requirements-dev.txt`
+    -   `make dev`
 
 ### For windows users
 

pymove/preprocessing/filters.py

@@ -17,8 +17,8 @@
 )
 
 if TYPE_CHECKING:
-    from pymove.core.pandas import PandasMoveDataFrame
     from pymove.core.dask import DaskMoveDataFrame
+    from pymove.core.pandas import PandasMoveDataFrame
 
 
 def get_bbox_by_radius(

pymove/preprocessing/segmentation.py

@@ -18,8 +18,8 @@
 from pymove.utils.log import progress_bar, timer_decorator
 
 if TYPE_CHECKING:
-    from pymove.core.pandas import PandasMoveDataFrame
     from pymove.core.dask import DaskMoveDataFrame
+    from pymove.core.pandas import PandasMoveDataFrame
 
 
 @timer_decorator