ez-address-parser


Nameez-address-parser JSON
Version 0.2.5 PyPI version JSON
download
home_page
SummaryA parser for Canadian postal addresses
upload_time2024-02-06 06:00:04
maintainer
docs_urlNone
author
requires_python>=3.8
license
keywords adress parser canadian
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            <div align="center">
    <img src="https://cdn2.iconfinder.com/data/icons/seo-and-website/100/SEO_search_word-512.png" alt="logo" height="128">
</div>

# ez-address-parser

[![pytest](https://github.com/zehengl/ez-address-parser/actions/workflows/pytest.yml/badge.svg)](https://github.com/zehengl/ez-address-parser/actions/workflows/pytest.yml)
![coding_style](https://img.shields.io/badge/code%20style-black-000000.svg)
![PyPI - License](https://img.shields.io/pypi/l/ez-address-parser)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ez-address-parser)
![PyPI - Wheel](https://img.shields.io/pypi/wheel/ez-address-parser)
[![Downloads](https://static.pepy.tech/badge/ez-address-parser)](https://pepy.tech/project/ez-address-parser)
[![GitHub Pages](https://github.com/zehengl/ez-address-parser/actions/workflows/gh-deploy.yml/badge.svg)](https://github.com/zehengl/ez-address-parser/actions/workflows/gh-deploy.yml)

A parser for Canadian postal addresses

## Install

From [PyPi](https://pypi.org/project/ez-address-parser/)

    pip install ez-address-parser

From [GitHub](https://github.com/zehengl/ez-address-parser)

    pip install git+https://github.com/zehengl/ez-address-parser.git

## Usage

### Command Line

    python -m ez_address_parser --address <some-address>

### Code (with pretrained model)

```python
from ez_address_parser import AddressParser

ap = AddressParser()

address = input("Address: ")
result = ap.parse(address)
for token, label in result:
    print(f"{token:20s} -> {label}")
```

### Code (without pretrained model)

```python
from ez_address_parser import AddressParser

ap = AddressParser(use_pretrained=False)

data = [
    [
        ('123', 'StreetNumber'),
        ('Main', 'StreetName'),
        ('St', 'StreetType'),
        ('E', 'StreetDirection')
    ],
    ...
] # list of list of (<token>, <label>) tuple

ap.train(data)

address = input("Address: ")
result = ap.parse(address)
for token, label in result:
    print(f"{token:20s} -> {label}")
```

## Credits

- [Icon][1] by [Rakhmat Setiawan][2]

[1]: https://www.iconfinder.com/icons/3059893/find_magnifier_search_seo_word_icon
[2]: https://www.iconfinder.com/rsetiawan93

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "ez-address-parser",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "Zeheng Li <imzehengl@gmail.com>",
    "keywords": "adress parser,Canadian",
    "author": "",
    "author_email": "Zeheng Li <imzehengl@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/15/66/16892aca8c8a1e5125791be1bd3ce5e328bab7d3e6ac494008b07435b183/ez-address-parser-0.2.5.tar.gz",
    "platform": null,
    "description": "<div align=\"center\">\n    <img src=\"https://cdn2.iconfinder.com/data/icons/seo-and-website/100/SEO_search_word-512.png\" alt=\"logo\" height=\"128\">\n</div>\n\n# ez-address-parser\n\n[![pytest](https://github.com/zehengl/ez-address-parser/actions/workflows/pytest.yml/badge.svg)](https://github.com/zehengl/ez-address-parser/actions/workflows/pytest.yml)\n![coding_style](https://img.shields.io/badge/code%20style-black-000000.svg)\n![PyPI - License](https://img.shields.io/pypi/l/ez-address-parser)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ez-address-parser)\n![PyPI - Wheel](https://img.shields.io/pypi/wheel/ez-address-parser)\n[![Downloads](https://static.pepy.tech/badge/ez-address-parser)](https://pepy.tech/project/ez-address-parser)\n[![GitHub Pages](https://github.com/zehengl/ez-address-parser/actions/workflows/gh-deploy.yml/badge.svg)](https://github.com/zehengl/ez-address-parser/actions/workflows/gh-deploy.yml)\n\nA parser for Canadian postal addresses\n\n## Install\n\nFrom [PyPi](https://pypi.org/project/ez-address-parser/)\n\n    pip install ez-address-parser\n\nFrom [GitHub](https://github.com/zehengl/ez-address-parser)\n\n    pip install git+https://github.com/zehengl/ez-address-parser.git\n\n## Usage\n\n### Command Line\n\n    python -m ez_address_parser --address <some-address>\n\n### Code (with pretrained model)\n\n```python\nfrom ez_address_parser import AddressParser\n\nap = AddressParser()\n\naddress = input(\"Address: \")\nresult = ap.parse(address)\nfor token, label in result:\n    print(f\"{token:20s} -> {label}\")\n```\n\n### Code (without pretrained model)\n\n```python\nfrom ez_address_parser import AddressParser\n\nap = AddressParser(use_pretrained=False)\n\ndata = [\n    [\n        ('123', 'StreetNumber'),\n        ('Main', 'StreetName'),\n        ('St', 'StreetType'),\n        ('E', 'StreetDirection')\n    ],\n    ...\n] # list of list of (<token>, <label>) tuple\n\nap.train(data)\n\naddress = input(\"Address: \")\nresult = ap.parse(address)\nfor token, label in result:\n    print(f\"{token:20s} -> {label}\")\n```\n\n## Credits\n\n- [Icon][1] by [Rakhmat Setiawan][2]\n\n[1]: https://www.iconfinder.com/icons/3059893/find_magnifier_search_seo_word_icon\n[2]: https://www.iconfinder.com/rsetiawan93\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "A parser for Canadian postal addresses",
    "version": "0.2.5",
    "project_urls": {
        "homepage": "https://zehengl.github.io/ez-address-parser/",
        "repository": "https://github.com/zehengl/ez-address-parser"
    },
    "split_keywords": [
        "adress parser",
        "canadian"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "770f4a5cf69747c27faf64963f46800edd1ae28999df8171980c4a6aa803047d",
                "md5": "61919bb0fafe9066e9915d368ce1ed25",
                "sha256": "f1a5c958971276e6046da530d6c10cbdaddb704ca8a2f818fbb50b76d5842333"
            },
            "downloads": -1,
            "filename": "ez_address_parser-0.2.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "61919bb0fafe9066e9915d368ce1ed25",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 27958,
            "upload_time": "2024-02-06T06:00:01",
            "upload_time_iso_8601": "2024-02-06T06:00:01.171092Z",
            "url": "https://files.pythonhosted.org/packages/77/0f/4a5cf69747c27faf64963f46800edd1ae28999df8171980c4a6aa803047d/ez_address_parser-0.2.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "156616892aca8c8a1e5125791be1bd3ce5e328bab7d3e6ac494008b07435b183",
                "md5": "65cfa8516215c33a3b904a6c7092d78b",
                "sha256": "ddd2bf780615ef788dd3ed3560c6f75dfab2c930efa48076b13b1fca3d9943cc"
            },
            "downloads": -1,
            "filename": "ez-address-parser-0.2.5.tar.gz",
            "has_sig": false,
            "md5_digest": "65cfa8516215c33a3b904a6c7092d78b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 33147,
            "upload_time": "2024-02-06T06:00:04",
            "upload_time_iso_8601": "2024-02-06T06:00:04.188803Z",
            "url": "https://files.pythonhosted.org/packages/15/66/16892aca8c8a1e5125791be1bd3ce5e328bab7d3e6ac494008b07435b183/ez-address-parser-0.2.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-06 06:00:04",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "zehengl",
    "github_project": "ez-address-parser",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "ez-address-parser"
}
Elapsed time: 0.70496s