japanese-address-parser

A Rust Library to parse japanese addresses.

Usage

Add this to your Cargo.toml

cargo add japanese-address-parser

Async Version

use japanese_address_parser::parser::Parser;

#[tokio::main]
async fn main() {
    let parser = Parser::new();
    let parse_result = parser.parse("東京都千代田区丸の内1-1-1").await;
    println!("{:?}", parse_result);
}

Blocking Version

use japanese_address_parser::api::{BlockingApi, BlockingApiImpl};
use japanese_address_parser::parser::parse_blocking;

fn main() {
    let blocking_api = BlockingApiImpl::new();
    let parse_result = parse_blocking(blocking_api, "東京都千代田区丸の内1-1-1");
    println!("{:?}", parse_result);
}

Wasm support

This crate is designed to be buildable for wasm32-unknown-unknown with wasm-pack. Pre-compiled wasm module is available npmjs.com

npm install @toriyama/japanese-address-parser

import init, {Parser} from "@toriyama/japanese-address-parser"

init().then(() => {
    const parser = new Parser()
    parser.parse("東京都千代田区丸の内1-1-1").then(parseResult => {
        console.log(JSON.stringify(parseResult, null, "\t"))
    })
})

Python support(experimental)

This library can be called from Python world. For more detail, see python module's README.

Support

This software is maintained by YuukiToriyama. If you have questions, please create an issue.

Acknowledgements

This software was developed inspired by @geolonia/normalize-japanese-addresses.
Also, the parsing process uses Geolonia 住所データ provided by 株式会社Geolonia.

License

This crate is distributed under the terms of the MIT license.