Merge pull request #20 from addok/modernize

Modernize Python packaging and CI

Author: jdesboeufs

.github/workflows/ci.yml

@@ -0,0 +1,40 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.9', '3.14']
+      fail-fast: false
+    services:
+      redis:
+        image: redis
+        options:
+          --health-cmd "redis-cli ping" --health-interval 10s --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 6379:6379
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e ".[dev]"
+
+    - name: Run tests with pytest
+      run: |
+        pytest --cov=addok_france --cov-report=term-missing

.gitignore

@@ -2,3 +2,7 @@ __pycache__
 *.pyc
 .cache
 *.egg-info
+.venv
+venv
+build
+dist

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 DINSIC/Etalab
+Copyright (c) 2016 République Française
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

MANIFEST.in

@@ -0,0 +1,21 @@
+develop:
+	pip install -e ".[dev]"
+
+test:
+	python -m pytest
+
+testcoverage:
+	python -m pytest --cov-report lcov --cov=addok_france tests/
+
+clean:
+	rm -rf dist/ build/
+
+dist: clean test
+	python -m build
+
+upload: dist
+	@if [ -z "$$(ls dist/*.whl dist/*.tar.gz 2>/dev/null)" ]; then \
+		echo "Error: No distribution files found. Run 'make dist' first."; \
+		exit 1; \
+	fi
+	twine upload dist/*

Makefile

@@ -1,33 +1,56 @@
-# Addok plugin for France specifics
+# addok-france
 
-## Installation
+Addok plugin for France-specific address geocoding with advanced query processing and result formatting.
+
+## Features
 
-    pip install addok-france
+- **Query preprocessing**: Extract and clean French address components
+- **Ordinal number handling**: Proper processing of ordinal numbers (1er, 2ème, etc.)
+- **House number flagging**: Specialized handling of French house numbers
+- **French labels**: France-specific result label formatting
+
+## Installation
 
+```bash
+pip install addok-france
+```
 
 ## Configuration
 
-- Add QUERY_PROCESSORS_PYPATHS
+### Query processors
+
+Add France-specific query processors to handle address extraction and cleaning:
+
+```python
+QUERY_PROCESSORS_PYPATHS = [
+    …,
+    "addok_france.extract_address",
+    "addok_france.clean_query",
+]
+```
+
+### String processors
+
+Add processors for ordinal numbers and house number handling:
 
-    QUERY_PROCESSORS_PYPATHS = [
-        …,
-        "addok_france.extract_address",
-        "addok_france.clean_query",
-    ]
+```python
+PROCESSORS_PYPATHS = [
+    …,
+    "addok_france.glue_ordinal",
+    "addok_france.fold_ordinal",
+    "addok_france.flag_housenumber",
+    …,
+]
+```
 
-- Add PROCESSORS_PYPATHS
+### Result processors
 
-    PROCESSORS_PYPATHS = [
-        …,
-        "addok_france.glue_ordinal",
-        "addok_france.fold_ordinal",
-        "addok_france.flag_housenumber",
-        …,
-    ]
+Replace default `make_labels` with France-specific label formatting:
 
-- Replace default `make_labels` by France dedicated one:
+```python
+SEARCH_RESULT_PROCESSORS_PYPATHS = [
+    'addok_france.make_labels',
+    …,
+]
+```
 
-    SEARCH_RESULT_PROCESSORS_PYPATHS = [
-        'addok_france.make_labels',
-        …,
-    ]

README.md

@@ -0,0 +1,53 @@
+[build-system]
+requires = ["setuptools>=65.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "addok-france"
+version = "1.1.3"
+description = "Addok plugin for France-specific address geocoding."
+readme = "README.md"
+authors = [
+    {name = "Yohan Boniface", email = "yohan.boniface@data.gouv.fr"}
+]
+license = "MIT"
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Topic :: Scientific/Engineering :: GIS",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+]
+keywords = ["addok", "geocoding", "france", "plugin"]
+requires-python = ">=3.9"
+dependencies = [
+    "addok",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest~=8.3",
+    "pytest-cov~=6.1",
+    "build~=1.2",
+    "twine==6.1.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/etalab/addok-france"
+
+[project.entry-points."addok.ext"]
+france = "addok_france"
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.packages.find]
+exclude = ["tests*", "venv*", ".venv*", "build*", "dist*"]
+
+[tool.pytest.ini_options]
+addopts = "-x"