refactor: правки по ревью — deps, tests/CI, константы, рефактор методов

Author: Mvin8

.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: CI
+
+on:
+  push:
+    branches: [ main, develop ]
+  pull_request:
+    branches: [ main, develop ]
+
+jobs:
+  lint-and-test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+      - name: Install deps
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e '.[dev]'
+      - name: Black check
+        run: black --check popframe tests
+      - name: Isort check
+        run: isort --check-only popframe tests
+      - name: Pylint (non-blocking)
+        run: |
+          pylint popframe || true
+      - name: Pytest
+        run: pytest -q

.pre-commit-config.yaml

@@ -14,3 +14,10 @@ repos:
     rev: 22.10.0
     hooks:
     -   id: black
+        args: ["--line-length=120"]
+
+-   repo: https://github.com/PyCQA/isort
+    rev: 5.13.2
+    hooks:
+    -   id: isort
+        args: ["--profile=black", "--line-length=120"]

README.rst

@@ -83,7 +83,7 @@ Below are examples for the main modules of PopFrame.
 **1. Region (models):**
 ```python
 from popframe.models.region import Region
-region = Region.from_pickle('data/region.pickle')
+region = Region.from_pickle('examples/data/Ленинградская область.pickle')
 print(region.towns)
 ```
 
@@ -140,6 +140,14 @@ from popframe.utils.const import *
 See more examples in the `examples/` directory and documentation.
 Больше примеров — в папке `examples/` и в документации.
 
+Data for the notebooks is provided under `examples/data`.
+- EN: Example notebooks expect inputs from `examples/data` (GeoJSON/Pickle). If you use your own region, update paths accordingly.
+- RU: Для запуска ноутбуков используйте данные из `examples/data`. Если работаете со своими данными, поправьте пути в ноутбуках.
+
+Notes on external data access:
+- EN: Some examples fetch OpenStreetMap data (e.g., land use). Ensure internet access. If your environment requires VPN (e.g., Forti), connect before running.
+- RU: Часть примеров получает данные из OSM. Нужен доступ в интернет (при необходимости подключите VPN, например Forti).
+
 Project Structure / Структура проекта
 ------------------------------------
 
@@ -254,5 +262,3 @@ Contacts / Контакты
 
 
 
-
-

examples/aglomeration.ipynb

@@ -9,15 +9,10 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 1,
+   "execution_count": null,
    "metadata": {},
    "outputs": [],
    "source": [
-    "# import osmnx as ox\n",
-    "import pandas as pd\n",
-    "import geopandas as gpd\n",
-    "import networkx as nx\n",
-    "import numpy as np\n",
     "import warnings\n",
     "import sys\n",
     "import os\n",
@@ -1742,7 +1737,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.11"
+   "version": "3.10.12"
   },
   "orig_nbformat": 4
  },

examples/criterion_hex.ipynb

@@ -285,7 +285,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.11"
+   "version": "3.10.12"
   },
   "orig_nbformat": 4
  },

examples/engineer.ipynb

@@ -9,7 +9,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 6,
+   "execution_count": null,
    "metadata": {},
    "outputs": [
     {
@@ -121,12 +121,11 @@
     }
    ],
    "source": [
-    "import json\n",
     "from io import StringIO\n",
     "from popframe.method.landuse_assessment import LandUseAssessment\n",
     "from popframe.models.region import Region\n",
     "import geopandas as gpd\n",
-    "from loguru import logger\n",
+    "\n",
     "\n",
     "region_model = Region.from_pickle('data/Ленинградская область.pickle')\n",
     "grid = gpd.read_file('data/gdf_hex.geojson', engine=\"pyogrio\")\n",
@@ -538,7 +537,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.11"
+   "version": "3.10.12"
   },
   "orig_nbformat": 4
  },