kenall_rs/
lib.rs

1//! # kenall-rs: A command line tool of [Kenall](https://kenall.jp/).
2//!
3//! Kenall is a efficient service for searching japanese address from postal code and making
4//! complexity simple and straightforward.
5//! This is an **unofficial** [cli tool](https://github.com/chansuke/kenall-rs) for the service.
6//!
7//! If you want to check the detail of the API, please check the [official document](https://www.notion.so/API-47ab1a425d9e48aaad5b34b4f703c718)
8//!
9//! # Getting Started
10//!
11//! First, you need to (signup)[https://kenall.jp/signup] to Kenall and get an API key.
12//! Once you have an API key, please write your API key into `.env` file.
13//! You can create the `.env` file by copying `.env.example` file.
14//!
15//! ```sh
16//! $ cp example.env .env
17//! $ vi .env
18//! ```
19//!
20//! # Usage
21//!
22//! Please enter valid japanese post number and you will get the address.
23//!
24//! ```sh
25//! kenall-rs 100-0001
26//! ```
27//!
28//! or
29//!
30//! ```sh
31//! kenall-rs 100-0001
32//! ```
33
34pub mod api;
35pub mod cli;
36pub mod errors;
37pub mod model;
38pub mod ui;
39
40pub use crate::api::fetch_address;
41pub use crate::cli::run;
42pub use crate::errors::KenallError;
43pub use crate::model::PostalCodeResponse;
44pub use crate::ui::Ui;