Metadata-Version: 2.4
Name: addok-france
Version: 1.2.0
Summary: Addok plugin for France-specific address geocoding.
Author-email: Yohan Boniface <yohan.boniface@data.gouv.fr>
License-Expression: MIT
Project-URL: Homepage, https://github.com/etalab/addok-france
Keywords: addok,geocoding,france,plugin
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Topic :: Scientific/Engineering :: GIS
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: addok
Provides-Extra: dev
Requires-Dist: pytest~=8.3; extra == "dev"
Requires-Dist: pytest-cov~=6.1; extra == "dev"
Requires-Dist: build~=1.2; extra == "dev"
Requires-Dist: twine==6.1.0; extra == "dev"
Dynamic: license-file

# addok-france

Addok plugin for France-specific address geocoding with advanced query processing and result formatting.

## Features

- **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

### 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:

```python
PROCESSORS_PYPATHS = [
    …,
    "addok_france.glue_ordinal",
    "addok_france.fold_ordinal",
    "addok_france.flag_housenumber",
    …,
]
```

### Result processors

Replace default `make_labels` with France-specific label formatting:

```python
SEARCH_RESULT_PROCESSORS_PYPATHS = [
    'addok_france.make_labels',
    …,
]
```

