| Name | ukaddresskit JSON |
| Version |
0.0.2
JSON |
| download |
| home_page | None |
| Summary | UK address parser and named entity recognition (NER) using machine learning with utilities. |
| upload_time | 2025-08-24 20:28:00 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | Copyright (c) 2018 The Python Packaging Authority
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE. |
| keywords |
ner
uk
addresses
parsing
postcode
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# ukaddress-ner
UK address NER using CRFsuite with postcode utilities, a model manager, and a CLI.
## Install
```bash
pip install uk-address
```
## Quick Start
Python
```python
from ukaddress import parse, tag
print(parse("10 Downing Street SW1A 2AA"))
print(tag("Flat 2, 10 Queen Street, Bury BL8 1JG"))
```
CLI
```cli
ukaddress parse "10 Downing Street SW1A 2AA" # auto-resolves model
ukaddress tag "Flat 2, 10 Queen Street, Bury BL8 1JG"
ukaddress postcode "SW1A1AA" --town --county
```
## Postcode Helpers
```python
from ukaddress import normalize_postcode, get_post_town, get_county
normalize_postcode("sw1a2aa") # "SW1A 2AA"
get_post_town("SW1A 2AA") # "LONDON"
get_county("SW1A 2AA") # "Greater London" (if in mapping)
```
## Todo
- [ ] Add outcode_to_county.csv into lookups
Raw data
{
"_id": null,
"home_page": null,
"name": "ukaddresskit",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "NER, UK, addresses, parsing, postcode",
"author": null,
"author_email": "Usama Shahid <usamashahid.us8@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/a1/10/84f2c6838c532e5bcabcb63ddbac6df56e2a12a3d9d2a4e2d422d68c7481/ukaddresskit-0.0.2.tar.gz",
"platform": null,
"description": "# ukaddress-ner\n\nUK address NER using CRFsuite with postcode utilities, a model manager, and a CLI.\n\n## Install\n\n```bash\npip install uk-address\n```\n\n## Quick Start\n\nPython\n```python\nfrom ukaddress import parse, tag\n\n\nprint(parse(\"10 Downing Street SW1A 2AA\"))\nprint(tag(\"Flat 2, 10 Queen Street, Bury BL8 1JG\"))\n```\n\nCLI\n```cli\nukaddress parse \"10 Downing Street SW1A 2AA\" # auto-resolves model\nukaddress tag \"Flat 2, 10 Queen Street, Bury BL8 1JG\"\nukaddress postcode \"SW1A1AA\" --town --county\n```\n\n## Postcode Helpers\n\n```python\nfrom ukaddress import normalize_postcode, get_post_town, get_county\nnormalize_postcode(\"sw1a2aa\") # \"SW1A 2AA\"\nget_post_town(\"SW1A 2AA\") # \"LONDON\"\nget_county(\"SW1A 2AA\") # \"Greater London\" (if in mapping)\n```\n\n\n## Todo\n\n- [ ] Add outcode_to_county.csv into lookups",
"bugtrack_url": null,
"license": "Copyright (c) 2018 The Python Packaging Authority\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.",
"summary": "UK address parser and named entity recognition (NER) using machine learning with utilities.",
"version": "0.0.2",
"project_urls": {
"Homepage": "https://github.com/reachusama/ukaddresskit",
"Issues": "https://github.com/reachusama/ukaddresskit/issues"
},
"split_keywords": [
"ner",
" uk",
" addresses",
" parsing",
" postcode"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "d8a1150193c6ff20911e5232776286cd430bb15d52c62048079025ca90c2dbe2",
"md5": "23a655542558912678c84c0b3d903eab",
"sha256": "9710e0d3e7dbecd1efd48eb0128fff7aba6f46b562f40701291d12746558aa65"
},
"downloads": -1,
"filename": "ukaddresskit-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "23a655542558912678c84c0b3d903eab",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 4137317,
"upload_time": "2025-08-24T20:27:55",
"upload_time_iso_8601": "2025-08-24T20:27:55.983615Z",
"url": "https://files.pythonhosted.org/packages/d8/a1/150193c6ff20911e5232776286cd430bb15d52c62048079025ca90c2dbe2/ukaddresskit-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "a11084f2c6838c532e5bcabcb63ddbac6df56e2a12a3d9d2a4e2d422d68c7481",
"md5": "3897754c86b46ca8fa60fe481ad7500e",
"sha256": "65457098c34d12455387bc4e2baed8f4b173dab3f463de0a266aac9b4fb78a87"
},
"downloads": -1,
"filename": "ukaddresskit-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "3897754c86b46ca8fa60fe481ad7500e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 4140662,
"upload_time": "2025-08-24T20:28:00",
"upload_time_iso_8601": "2025-08-24T20:28:00.981709Z",
"url": "https://files.pythonhosted.org/packages/a1/10/84f2c6838c532e5bcabcb63ddbac6df56e2a12a3d9d2a4e2d422d68c7481/ukaddresskit-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-24 20:28:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "reachusama",
"github_project": "ukaddresskit",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "ukaddresskit"
}
