Metadata-Version: 2.1
Name: ksj
Version: 1.0.0
Summary: This library will make the Kokudo Suuchi Jouhou API easy to use.
Home-page: https://github.com/nigimitama/ksj
Author: Masayoshi Mita
Author-email: nigimitama16@gmail.com
License: MIT
Platform: UNKNOWN
Description-Content-Type: text/markdown
Requires-Dist: lxml (>=4.4.0)
Requires-Dist: xmljson (>=0.2.0)
Requires-Dist: xlrd (>=1.2.0)
Requires-Dist: geopandas (>=0.6.0)

# ksj

[![CircleCI](https://circleci.com/gh/nigimitama/ksj/tree/master.svg?style=svg)](https://circleci.com/gh/nigimitama/ksj/tree/master)

[国土数値情報ダウンロードサービス](http://nlftp.mlit.go.jp/ksj/index.html)のWeb APIを簡単に扱うためのPythonパッケージです。

データ分析での利用を想定しており、本パッケージのメソッドの返り値はpandasやgeopandasのオブジェクトになります。



## インストール方法

```
pip install ksj
```

⚠️Windowsの場合[geopandasの依存パッケージ](http://geopandas.org/install.html#installing-with-pip)がpipではインストールできないため、**先にそちらをインストールする必要があります。** ご注意ください。

UNIX系OSの場合、`pip install ksj`だけでgeopandasもインストールされます。



## ドキュメント

使用方法は[ksj documentation](https://nigimitama.github.io/ksj/)をご覧ください



## 利用上の注意

APIの利用やAPIで得られる国土数値情報の利用にあたっては、国土数値情報ダウンロードサービスの利用約款および同Web APIの利用規約をご確認の上ご利用ください。

- http://nlftp.mlit.go.jp/ksj/other/yakkan.html
- http://nlftp.mlit.go.jp/ksj/api/about_api.html




