langchain-gridpin 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
@@ -0,0 +1,106 @@
1
+ Metadata-Version: 2.4
2
+ Name: langchain-gridpin
3
+ Version: 0.1.0
4
+ Summary: LangChain tools for offline geocoding with GridPin: addresses to coordinates and back from one local file per country, no API key
5
+ License-Expression: Apache-2.0
6
+ Project-URL: Homepage, https://gridpin.dev
7
+ Project-URL: Documentation, https://gridpin.dev/docs
8
+ Project-URL: Repository, https://github.com/gridpin/gridpin
9
+ Project-URL: Issues, https://github.com/gridpin/gridpin/issues
10
+ Keywords: langchain,geocoding,geocoder,offline,reverse-geocoding,gis,tools,ai-agents
11
+ Classifier: Development Status :: 4 - Beta
12
+ Classifier: Programming Language :: Python :: 3
13
+ Classifier: Topic :: Scientific/Engineering :: GIS
14
+ Requires-Python: >=3.10
15
+ Description-Content-Type: text/markdown
16
+ License-File: LICENSE
17
+ Requires-Dist: langchain-core<2,>=1.0
18
+ Requires-Dist: gridpin-mcp<0.3,>=0.2
19
+ Dynamic: license-file
20
+
21
+ # langchain-gridpin — offline geocoding tools for LangChain
22
+
23
+ LangChain tools that turn addresses into coordinates and coordinates into addresses with
24
+ [GridPin](https://gridpin.dev): one memory-mapped file per country ("sheet"), read on your
25
+ machine. No API key, no rate limit, and no query leaves the machine. The only network step is
26
+ downloading a sheet once, verified against the signed GridPin release.
27
+
28
+ Covered countries and sheet sizes: [gridpin.dev](https://gridpin.dev).
29
+
30
+ ## Install
31
+
32
+ ```console
33
+ $ pip install langchain-gridpin
34
+ $ gridpin-fetch us # once: downloads and verifies the sheet, prints its path
35
+ ```
36
+
37
+ `gridpin-fetch` comes with the `gridpin-mcp` dependency. Sheets go to `$GRIDPIN_HOME`, else
38
+ `$XDG_CACHE_HOME/gridpin`, else `~/.cache/gridpin`. From Python:
39
+
40
+ ```python
41
+ from langchain_gridpin import download_sheet
42
+
43
+ download_sheet("us") # no network when the sheet is already there
44
+ ```
45
+
46
+ ## Use the tools
47
+
48
+ ```python
49
+ from langchain_gridpin import GridPinGeocode, GridPinReverse
50
+
51
+ geocode = GridPinGeocode(country="us")
52
+ geocode.invoke({"query": "1600 Pennsylvania Ave NW, Washington, DC 20500"})
53
+ # '{"country": "us", "query": "1600 Pennsylvania Ave NW, Washington, DC 20500",
54
+ # "results": [{"lat": 38.8976751, "lon": -77.036547, "precision": "house", ...}]}'
55
+
56
+ reverse = GridPinReverse(country="us")
57
+ reverse.invoke({"lat": 38.8977, "lon": -77.0365})
58
+ # '{"country": "us", "lat": 38.8977, "lon": -77.0365,
59
+ # "results": [{"housenumber": "1600", "street": "PENNSYLVANIA Avenue Northwest", "distance_m": 4.9, ...}]}'
60
+ ```
61
+
62
+ Both tools for one country, for an agent (`pip install langchain langchain-anthropic`, or any
63
+ other chat model with tool calling):
64
+
65
+ ```python
66
+ from langchain.agents import create_agent
67
+ from langchain_gridpin import GridPinToolkit
68
+
69
+ agent = create_agent("anthropic:claude-sonnet-5-5", tools=GridPinToolkit(country="us").get_tools())
70
+ agent.invoke({"messages": [{"role": "user", "content": "Where is 350 5th Ave, New York?"}]})
71
+ ```
72
+
73
+ | Tool | Arguments | Returns |
74
+ |---|---|---|
75
+ | `GridPinGeocode` (name `gridpin_geocode_<country>`) | `query`, `k` (1-10, default 1) | ranked candidates with `lat`, `lon`, `precision`, `confidence`, `street`, `housenumber`, `commune`, `postcode` |
76
+ | `GridPinReverse` (name `gridpin_reverse_<country>`) | `lat`, `lon`, `k` (1-10, default 1) | nearest indexed addresses, each with `distance_m` |
77
+
78
+ Constructor parameters of both tools and of `GridPinToolkit`:
79
+
80
+ - `country` — country code or English name of the sheet, e.g. `"us"`. An unknown country fails
81
+ at construction and the error lists the available ones.
82
+ - `sheet` — optional path to a sheet file, instead of the downloaded one.
83
+
84
+ The tools use `response_format="content_and_artifact"`: called by an agent, the `ToolMessage`
85
+ carries the answer as JSON text in `content` and as a dict in `artifact`. Called directly with a
86
+ dict, as above, they return the JSON text. Tools reading the same sheet share one open file.
87
+
88
+ A missing sheet or an empty query comes back to the model as an error message it can act on
89
+ (for example "run `gridpin-fetch us`"); set `handle_tool_error=False` to get an exception
90
+ instead. An address that is not found is not an error: `results` is an empty list.
91
+
92
+ Results are the same as the GridPin CLI, Python, DuckDB and MCP server return. Treat `street`
93
+ or `city` precision as approximate.
94
+
95
+ ## Links
96
+
97
+ - GridPin: [gridpin.dev](https://gridpin.dev), [documentation](https://gridpin.dev/docs),
98
+ [benchmark](https://gridpin.dev/bench)
99
+ - Source: [github.com/gridpin/gridpin](https://github.com/gridpin/gridpin) (this package lives in
100
+ `integrations/langchain/`)
101
+ - MCP server for other agent frameworks: [gridpin-mcp](https://pypi.org/project/gridpin-mcp/)
102
+
103
+ If GridPin is useful to you, [a star on GitHub](https://github.com/gridpin/gridpin) helps other
104
+ people find it.
105
+
106
+ License: Apache-2.0.
@@ -0,0 +1,86 @@
1
+ # langchain-gridpin — offline geocoding tools for LangChain
2
+
3
+ LangChain tools that turn addresses into coordinates and coordinates into addresses with
4
+ [GridPin](https://gridpin.dev): one memory-mapped file per country ("sheet"), read on your
5
+ machine. No API key, no rate limit, and no query leaves the machine. The only network step is
6
+ downloading a sheet once, verified against the signed GridPin release.
7
+
8
+ Covered countries and sheet sizes: [gridpin.dev](https://gridpin.dev).
9
+
10
+ ## Install
11
+
12
+ ```console
13
+ $ pip install langchain-gridpin
14
+ $ gridpin-fetch us # once: downloads and verifies the sheet, prints its path
15
+ ```
16
+
17
+ `gridpin-fetch` comes with the `gridpin-mcp` dependency. Sheets go to `$GRIDPIN_HOME`, else
18
+ `$XDG_CACHE_HOME/gridpin`, else `~/.cache/gridpin`. From Python:
19
+
20
+ ```python
21
+ from langchain_gridpin import download_sheet
22
+
23
+ download_sheet("us") # no network when the sheet is already there
24
+ ```
25
+
26
+ ## Use the tools
27
+
28
+ ```python
29
+ from langchain_gridpin import GridPinGeocode, GridPinReverse
30
+
31
+ geocode = GridPinGeocode(country="us")
32
+ geocode.invoke({"query": "1600 Pennsylvania Ave NW, Washington, DC 20500"})
33
+ # '{"country": "us", "query": "1600 Pennsylvania Ave NW, Washington, DC 20500",
34
+ # "results": [{"lat": 38.8976751, "lon": -77.036547, "precision": "house", ...}]}'
35
+
36
+ reverse = GridPinReverse(country="us")
37
+ reverse.invoke({"lat": 38.8977, "lon": -77.0365})
38
+ # '{"country": "us", "lat": 38.8977, "lon": -77.0365,
39
+ # "results": [{"housenumber": "1600", "street": "PENNSYLVANIA Avenue Northwest", "distance_m": 4.9, ...}]}'
40
+ ```
41
+
42
+ Both tools for one country, for an agent (`pip install langchain langchain-anthropic`, or any
43
+ other chat model with tool calling):
44
+
45
+ ```python
46
+ from langchain.agents import create_agent
47
+ from langchain_gridpin import GridPinToolkit
48
+
49
+ agent = create_agent("anthropic:claude-sonnet-5-5", tools=GridPinToolkit(country="us").get_tools())
50
+ agent.invoke({"messages": [{"role": "user", "content": "Where is 350 5th Ave, New York?"}]})
51
+ ```
52
+
53
+ | Tool | Arguments | Returns |
54
+ |---|---|---|
55
+ | `GridPinGeocode` (name `gridpin_geocode_<country>`) | `query`, `k` (1-10, default 1) | ranked candidates with `lat`, `lon`, `precision`, `confidence`, `street`, `housenumber`, `commune`, `postcode` |
56
+ | `GridPinReverse` (name `gridpin_reverse_<country>`) | `lat`, `lon`, `k` (1-10, default 1) | nearest indexed addresses, each with `distance_m` |
57
+
58
+ Constructor parameters of both tools and of `GridPinToolkit`:
59
+
60
+ - `country` — country code or English name of the sheet, e.g. `"us"`. An unknown country fails
61
+ at construction and the error lists the available ones.
62
+ - `sheet` — optional path to a sheet file, instead of the downloaded one.
63
+
64
+ The tools use `response_format="content_and_artifact"`: called by an agent, the `ToolMessage`
65
+ carries the answer as JSON text in `content` and as a dict in `artifact`. Called directly with a
66
+ dict, as above, they return the JSON text. Tools reading the same sheet share one open file.
67
+
68
+ A missing sheet or an empty query comes back to the model as an error message it can act on
69
+ (for example "run `gridpin-fetch us`"); set `handle_tool_error=False` to get an exception
70
+ instead. An address that is not found is not an error: `results` is an empty list.
71
+
72
+ Results are the same as the GridPin CLI, Python, DuckDB and MCP server return. Treat `street`
73
+ or `city` precision as approximate.
74
+
75
+ ## Links
76
+
77
+ - GridPin: [gridpin.dev](https://gridpin.dev), [documentation](https://gridpin.dev/docs),
78
+ [benchmark](https://gridpin.dev/bench)
79
+ - Source: [github.com/gridpin/gridpin](https://github.com/gridpin/gridpin) (this package lives in
80
+ `integrations/langchain/`)
81
+ - MCP server for other agent frameworks: [gridpin-mcp](https://pypi.org/project/gridpin-mcp/)
82
+
83
+ If GridPin is useful to you, [a star on GitHub](https://github.com/gridpin/gridpin) helps other
84
+ people find it.
85
+
86
+ License: Apache-2.0.
@@ -0,0 +1,36 @@
1
+ [build-system]
2
+ requires = ["setuptools>=77"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+ [project]
6
+ name = "langchain-gridpin"
7
+ version = "0.1.0"
8
+ description = "LangChain tools for offline geocoding with GridPin: addresses to coordinates and back from one local file per country, no API key"
9
+ readme = "README.md"
10
+ requires-python = ">=3.10"
11
+ license = "Apache-2.0"
12
+ license-files = ["LICENSE"]
13
+ keywords = ["langchain", "geocoding", "geocoder", "offline", "reverse-geocoding", "gis", "tools", "ai-agents"]
14
+ classifiers = [
15
+ "Development Status :: 4 - Beta",
16
+ "Programming Language :: Python :: 3",
17
+ "Topic :: Scientific/Engineering :: GIS",
18
+ ]
19
+ # gridpin-mcp brings the engine (gridpin) and the verified sheet downloader (gridpin-fetch).
20
+ dependencies = ["langchain-core>=1.0,<2", "gridpin-mcp>=0.2,<0.3"]
21
+
22
+ [project.urls]
23
+ Homepage = "https://gridpin.dev"
24
+ Documentation = "https://gridpin.dev/docs"
25
+ Repository = "https://github.com/gridpin/gridpin"
26
+ Issues = "https://github.com/gridpin/gridpin/issues"
27
+
28
+ [tool.setuptools.packages.find]
29
+ where = ["src"]
30
+
31
+ [tool.pytest.ini_options]
32
+ # The LangChain standard tests include async ones (pytest-asyncio comes with langchain-tests).
33
+ asyncio_mode = "auto"
34
+
35
+ [tool.setuptools.package-data]
36
+ langchain_gridpin = ["py.typed"]
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+
@@ -0,0 +1,11 @@
1
+ """LangChain tools for offline geocoding with GridPin."""
2
+
3
+ from langchain_gridpin.tools import (
4
+ GridPinGeocode,
5
+ GridPinReverse,
6
+ GridPinToolkit,
7
+ download_sheet,
8
+ )
9
+
10
+ __all__ = ["GridPinGeocode", "GridPinReverse", "GridPinToolkit", "download_sheet"]
11
+ __version__ = "0.1.0"
File without changes
@@ -0,0 +1,184 @@
1
+ """LangChain tools over a local GridPin sheet: address to coordinates and back, no API key.
2
+
3
+ Queries never leave the machine. The tools read a country sheet that is already on disk; they
4
+ do not download anything. Fetch a sheet once with ``gridpin-fetch <country>`` or
5
+ ``download_sheet``. The geocoding itself is the same code path as the GridPin MCP server
6
+ (``gridpin_mcp.tools``), so both return the same fields.
7
+ """
8
+
9
+ from __future__ import annotations
10
+
11
+ import json
12
+ import threading
13
+ from pathlib import Path
14
+ from typing import Any, Dict, List, Optional, Tuple, Type
15
+
16
+ from gridpin_mcp import sheets
17
+ from gridpin_mcp import tools as engine_tools
18
+ from langchain_core.callbacks import CallbackManagerForToolRun
19
+ from langchain_core.tools import BaseTool, BaseToolkit, ToolException
20
+ from pydantic import BaseModel, Field
21
+
22
+ MAX_K = engine_tools.MAX_K
23
+
24
+ _sessions: Dict[Optional[str], engine_tools.Session] = {}
25
+ _sessions_lock = threading.Lock()
26
+
27
+
28
+ def _session(sheet: Optional[str]) -> engine_tools.Session:
29
+ """One engine session per sheet source, shared by every tool that reads it."""
30
+ with _sessions_lock:
31
+ if sheet not in _sessions:
32
+ if sheet is None:
33
+ _sessions[sheet] = engine_tools.Session()
34
+ else:
35
+ path = Path(sheet).expanduser()
36
+
37
+ def open_sheet(code: str) -> Path:
38
+ if not path.is_file():
39
+ raise sheets.SheetError(f"no sheet file at {path}")
40
+ return path
41
+
42
+ _sessions[sheet] = engine_tools.Session(open_sheet=open_sheet)
43
+ return _sessions[sheet]
44
+
45
+
46
+ def download_sheet(country: str) -> Path:
47
+ """Fetch one country sheet into the GridPin cache (network, once) and return its path.
48
+
49
+ The download is checked against the size and SHA-256 pinned from the signed GridPin
50
+ release; a sheet that is already present is returned without any network access.
51
+ """
52
+ return sheets.download(country)
53
+
54
+
55
+ class GeocodeInput(BaseModel):
56
+ query: str = Field(
57
+ description="Address or place as a person would write it, "
58
+ "e.g. '1600 Pennsylvania Ave NW, Washington, DC 20500'"
59
+ )
60
+ k: int = Field(default=1, ge=1, le=MAX_K, description="Number of ranked candidates to return")
61
+
62
+
63
+ class ReverseInput(BaseModel):
64
+ lat: float = Field(ge=-90, le=90, description="Latitude in decimal degrees (WGS 84)")
65
+ lon: float = Field(ge=-180, le=180, description="Longitude in decimal degrees (WGS 84)")
66
+ k: int = Field(default=1, ge=1, le=MAX_K, description="Number of nearest addresses to return")
67
+
68
+
69
+ class _GridPinTool(BaseTool):
70
+ """Shared settings: which country sheet the tool reads, and how its errors reach the model."""
71
+
72
+ country: str
73
+ """Country code or English name of the sheet, e.g. ``"us"`` or ``"United States"``."""
74
+ sheet: Optional[str] = None
75
+ """Path to a sheet file; default is the downloaded sheet of ``country``."""
76
+
77
+ response_format: str = "content_and_artifact"
78
+ # A missing sheet or a bad query comes back to the model as a message it can act on.
79
+ handle_tool_error: bool = True
80
+
81
+ _verb = ""
82
+ _summary = ""
83
+
84
+ def model_post_init(self, context: Any) -> None:
85
+ super().model_post_init(context)
86
+ try:
87
+ found = sheets.resolve(self.country)
88
+ except sheets.SheetError as exc:
89
+ raise ValueError(str(exc)) from exc
90
+ self.country = found.code
91
+ if "name" not in self.model_fields_set:
92
+ self.name = f"gridpin_{self._verb}_{found.code}"
93
+ if "description" not in self.model_fields_set:
94
+ self.description = self._summary.format(country=found.name)
95
+
96
+ def _answer(self, call) -> Tuple[str, Dict[str, Any]]:
97
+ try:
98
+ out = call(_session(self.sheet))
99
+ except engine_tools.ToolError as exc:
100
+ raise ToolException(str(exc)) from exc
101
+ return json.dumps(out, ensure_ascii=False), out
102
+
103
+
104
+ class GridPinGeocode(_GridPinTool):
105
+ """Address or place text to coordinates, from a local GridPin sheet.
106
+
107
+ Example:
108
+ .. code-block:: python
109
+
110
+ from langchain_gridpin import GridPinGeocode
111
+
112
+ tool = GridPinGeocode(country="us")
113
+ tool.invoke({"query": "1600 Pennsylvania Ave NW, Washington, DC 20500"})
114
+ """
115
+
116
+ name: str = "gridpin_geocode"
117
+ description: str = "Geocode an address."
118
+ args_schema: Type[BaseModel] = GeocodeInput
119
+
120
+ _verb = "geocode"
121
+ _summary = (
122
+ "Offline geocoding of an address or place covered by the GridPin {country} sheet: "
123
+ "returns ranked candidates with lat, lon, precision (house, interp, street, city, ...) "
124
+ "and confidence. Treat street or city precision as approximate. An empty results list "
125
+ "means no match."
126
+ )
127
+
128
+ def _run(
129
+ self, query: str, k: int = 1, run_manager: Optional[CallbackManagerForToolRun] = None
130
+ ) -> Tuple[str, Dict[str, Any]]:
131
+ return self._answer(lambda s: s.geocode(query, self.country, k))
132
+
133
+
134
+ class GridPinReverse(_GridPinTool):
135
+ """Coordinates to the nearest addresses, from a local GridPin sheet.
136
+
137
+ Example:
138
+ .. code-block:: python
139
+
140
+ from langchain_gridpin import GridPinReverse
141
+
142
+ tool = GridPinReverse(country="us")
143
+ tool.invoke({"lat": 38.8977, "lon": -77.0365})
144
+ """
145
+
146
+ name: str = "gridpin_reverse"
147
+ description: str = "Reverse geocode coordinates."
148
+ args_schema: Type[BaseModel] = ReverseInput
149
+
150
+ _verb = "reverse"
151
+ _summary = (
152
+ "Offline reverse geocoding of a point covered by the GridPin {country} sheet: returns "
153
+ "the nearest indexed addresses, each with distance_m from the point."
154
+ )
155
+
156
+ def _run(
157
+ self,
158
+ lat: float,
159
+ lon: float,
160
+ k: int = 1,
161
+ run_manager: Optional[CallbackManagerForToolRun] = None,
162
+ ) -> Tuple[str, Dict[str, Any]]:
163
+ return self._answer(lambda s: s.reverse(lat, lon, self.country, k))
164
+
165
+
166
+ class GridPinToolkit(BaseToolkit):
167
+ """Both GridPin tools for one country sheet.
168
+
169
+ Example:
170
+ .. code-block:: python
171
+
172
+ from langchain_gridpin import GridPinToolkit
173
+
174
+ tools = GridPinToolkit(country="us").get_tools()
175
+ """
176
+
177
+ country: str
178
+ sheet: Optional[str] = None
179
+
180
+ def get_tools(self) -> List[BaseTool]:
181
+ return [
182
+ GridPinGeocode(country=self.country, sheet=self.sheet),
183
+ GridPinReverse(country=self.country, sheet=self.sheet),
184
+ ]
@@ -0,0 +1,106 @@
1
+ Metadata-Version: 2.4
2
+ Name: langchain-gridpin
3
+ Version: 0.1.0
4
+ Summary: LangChain tools for offline geocoding with GridPin: addresses to coordinates and back from one local file per country, no API key
5
+ License-Expression: Apache-2.0
6
+ Project-URL: Homepage, https://gridpin.dev
7
+ Project-URL: Documentation, https://gridpin.dev/docs
8
+ Project-URL: Repository, https://github.com/gridpin/gridpin
9
+ Project-URL: Issues, https://github.com/gridpin/gridpin/issues
10
+ Keywords: langchain,geocoding,geocoder,offline,reverse-geocoding,gis,tools,ai-agents
11
+ Classifier: Development Status :: 4 - Beta
12
+ Classifier: Programming Language :: Python :: 3
13
+ Classifier: Topic :: Scientific/Engineering :: GIS
14
+ Requires-Python: >=3.10
15
+ Description-Content-Type: text/markdown
16
+ License-File: LICENSE
17
+ Requires-Dist: langchain-core<2,>=1.0
18
+ Requires-Dist: gridpin-mcp<0.3,>=0.2
19
+ Dynamic: license-file
20
+
21
+ # langchain-gridpin — offline geocoding tools for LangChain
22
+
23
+ LangChain tools that turn addresses into coordinates and coordinates into addresses with
24
+ [GridPin](https://gridpin.dev): one memory-mapped file per country ("sheet"), read on your
25
+ machine. No API key, no rate limit, and no query leaves the machine. The only network step is
26
+ downloading a sheet once, verified against the signed GridPin release.
27
+
28
+ Covered countries and sheet sizes: [gridpin.dev](https://gridpin.dev).
29
+
30
+ ## Install
31
+
32
+ ```console
33
+ $ pip install langchain-gridpin
34
+ $ gridpin-fetch us # once: downloads and verifies the sheet, prints its path
35
+ ```
36
+
37
+ `gridpin-fetch` comes with the `gridpin-mcp` dependency. Sheets go to `$GRIDPIN_HOME`, else
38
+ `$XDG_CACHE_HOME/gridpin`, else `~/.cache/gridpin`. From Python:
39
+
40
+ ```python
41
+ from langchain_gridpin import download_sheet
42
+
43
+ download_sheet("us") # no network when the sheet is already there
44
+ ```
45
+
46
+ ## Use the tools
47
+
48
+ ```python
49
+ from langchain_gridpin import GridPinGeocode, GridPinReverse
50
+
51
+ geocode = GridPinGeocode(country="us")
52
+ geocode.invoke({"query": "1600 Pennsylvania Ave NW, Washington, DC 20500"})
53
+ # '{"country": "us", "query": "1600 Pennsylvania Ave NW, Washington, DC 20500",
54
+ # "results": [{"lat": 38.8976751, "lon": -77.036547, "precision": "house", ...}]}'
55
+
56
+ reverse = GridPinReverse(country="us")
57
+ reverse.invoke({"lat": 38.8977, "lon": -77.0365})
58
+ # '{"country": "us", "lat": 38.8977, "lon": -77.0365,
59
+ # "results": [{"housenumber": "1600", "street": "PENNSYLVANIA Avenue Northwest", "distance_m": 4.9, ...}]}'
60
+ ```
61
+
62
+ Both tools for one country, for an agent (`pip install langchain langchain-anthropic`, or any
63
+ other chat model with tool calling):
64
+
65
+ ```python
66
+ from langchain.agents import create_agent
67
+ from langchain_gridpin import GridPinToolkit
68
+
69
+ agent = create_agent("anthropic:claude-sonnet-5-5", tools=GridPinToolkit(country="us").get_tools())
70
+ agent.invoke({"messages": [{"role": "user", "content": "Where is 350 5th Ave, New York?"}]})
71
+ ```
72
+
73
+ | Tool | Arguments | Returns |
74
+ |---|---|---|
75
+ | `GridPinGeocode` (name `gridpin_geocode_<country>`) | `query`, `k` (1-10, default 1) | ranked candidates with `lat`, `lon`, `precision`, `confidence`, `street`, `housenumber`, `commune`, `postcode` |
76
+ | `GridPinReverse` (name `gridpin_reverse_<country>`) | `lat`, `lon`, `k` (1-10, default 1) | nearest indexed addresses, each with `distance_m` |
77
+
78
+ Constructor parameters of both tools and of `GridPinToolkit`:
79
+
80
+ - `country` — country code or English name of the sheet, e.g. `"us"`. An unknown country fails
81
+ at construction and the error lists the available ones.
82
+ - `sheet` — optional path to a sheet file, instead of the downloaded one.
83
+
84
+ The tools use `response_format="content_and_artifact"`: called by an agent, the `ToolMessage`
85
+ carries the answer as JSON text in `content` and as a dict in `artifact`. Called directly with a
86
+ dict, as above, they return the JSON text. Tools reading the same sheet share one open file.
87
+
88
+ A missing sheet or an empty query comes back to the model as an error message it can act on
89
+ (for example "run `gridpin-fetch us`"); set `handle_tool_error=False` to get an exception
90
+ instead. An address that is not found is not an error: `results` is an empty list.
91
+
92
+ Results are the same as the GridPin CLI, Python, DuckDB and MCP server return. Treat `street`
93
+ or `city` precision as approximate.
94
+
95
+ ## Links
96
+
97
+ - GridPin: [gridpin.dev](https://gridpin.dev), [documentation](https://gridpin.dev/docs),
98
+ [benchmark](https://gridpin.dev/bench)
99
+ - Source: [github.com/gridpin/gridpin](https://github.com/gridpin/gridpin) (this package lives in
100
+ `integrations/langchain/`)
101
+ - MCP server for other agent frameworks: [gridpin-mcp](https://pypi.org/project/gridpin-mcp/)
102
+
103
+ If GridPin is useful to you, [a star on GitHub](https://github.com/gridpin/gridpin) helps other
104
+ people find it.
105
+
106
+ License: Apache-2.0.
@@ -0,0 +1,11 @@
1
+ LICENSE
2
+ README.md
3
+ pyproject.toml
4
+ src/langchain_gridpin/__init__.py
5
+ src/langchain_gridpin/py.typed
6
+ src/langchain_gridpin/tools.py
7
+ src/langchain_gridpin.egg-info/PKG-INFO
8
+ src/langchain_gridpin.egg-info/SOURCES.txt
9
+ src/langchain_gridpin.egg-info/dependency_links.txt
10
+ src/langchain_gridpin.egg-info/requires.txt
11
+ src/langchain_gridpin.egg-info/top_level.txt
@@ -0,0 +1,2 @@
1
+ langchain-core<2,>=1.0
2
+ gridpin-mcp<0.3,>=0.2
@@ -0,0 +1 @@
1
+ langchain_gridpin