Metadata-Version: 2.1
Name: jageocoder_converter
Version: 0.2.1
Summary: A Python implementation of Japanese-address geocoder.
Home-page: https://github.com/t-sagara/jageocoder-converter
Author: Takeshi Sagara
Author-email: sagara@info-proto.com
License: MIT
Download-URL: https://github.com/t-sagara/jageocoder-converter
Keywords: geocoder,Japanese,address,converter
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Description-Content-Type: text/markdown
License-File: LICENSE

# jageocoder-converter

This package is a CUI application for creating an address dictionary for use with the address geocoder [jageocoder](https://github.com/t-sagara/jageocoder).
It can be used when you want to create a dictionary that includes only some prefectures.

For more detailed information, please refer to
[the Japanese document](doc/index.rst).

### Prerequisites

Requires Python 3.6.x or later.

### Installing

Install the package using `pip install jageocoder-converter`.

## Uninstalling

Remove the directory containing the database.
Then, do `pip uninstall jageocoder-converter`.

## Run

Show help with the following command.

```sh
python -m jageocoder_converter -h
``` 

To create a dictionary, specify the `convert` command.

```sh
python -m jageocoder_converter convert
```

During the process, it downloads the location reference information
needed to create the dictionary from the web. Before downloading,
you will be prompted with a link to the terms of use.
Be sure to read them, and enter a capital 'Y'.

**More examples**

To create a dictionary, including only 東京都,
without records from 住居表示住所, run the following command.

```sh
python -m jageocoder_converter convert --no-jusho 13
```

You may create a dictionary in the specified directory.

```sh
python -m jageocoder_converter convert --db-dir=oazadb --no-gaiku --no-jusho
```

If you already understand the terms of use, etc., and want to process it
in the background, you can specify the quiet option. It may be useful
to add a debug option to check the progress in the log file.

```sh
nohup python -m jageocoder_converter convert --quiet --debug &
```

## Authors

* Takeshi SAGARA - [Info-proto Co.,Ltd.](https://www.info-proto.com/)

## License

This project is licensed under [the MIT License](https://opensource.org/licenses/mit-license.php).

This is not the scope of the dictionary data license.
Please follow the terms of use of the respective dictionary data.


