https://github.com/lhr0909/address-extractor
A service that extracts addresses
https://github.com/lhr0909/address-extractor
Last synced: 7 months ago
JSON representation
A service that extracts addresses
- Host: GitHub
- URL: https://github.com/lhr0909/address-extractor
- Owner: lhr0909
- License: mit
- Created: 2021-03-17T04:08:02.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-03-17T08:42:08.000Z (over 4 years ago)
- Last Synced: 2025-01-11T16:13:38.806Z (9 months ago)
- Language: Python
- Size: 5.42 MB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# address-extractor
A service that extracts addresses. It first tries to find and parse the address from a blob of text and then uses libpostal to expand the address.
# Install & Run
## Prerequisites
- [pyenv](https://github.com/pyenv/pyenv-installer)
- poetry `pip install poetry`
## Local Run / Develop
To run / develop locally, first follow the instruction to [install libpostal](https://github.com/openvenues/libpostal#installation-maclinux).
[Alternative instruction from pypostal](https://github.com/openvenues/pypostal#installation)
Once libpostal is installed, run the following command to install dependencies:
```shell
poetry install
```
Run the following command to run the service:
```shell
make serve
```
visit https://localhost:7000/docs to check the API documentation in a Swagger UI.
## Docker Run
We have a [Dockerfile](./Dockerfile) included, which you could build yourself. There also will be a Docker Hub version available. A docker-compose sample will also be provided to see how to stand it up.
# License
[MIT](./LICENSE)
# Reference
- [Extracting Address from Text](https://onethinglab.com/2018/03/05/extracting-addresses-from-text/)
- [pyap](https://github.com/vladimarius/pyap)
- [libpostal](https://www.mapzen.com/blog/inside-libpostal/)
# Extension
- [address-net (Australian addresses)](https://towardsdatascience.com/addressnet-how-to-build-a-robust-street-address-parser-using-a-recurrent-neural-network-518d97b9aebd)