v1.0.0. Added sample web app.

t-sagara · Dec 10, 2021 · 20583ef · 20583ef
1 parent 69a2a62
commit 20583ef
Show file tree

Hide file tree

Showing 8 changed files with 144 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -113,6 +113,19 @@ python -m unittest
 Please use the dictionary coverter
 [jageocoder-converter](https://github.com/t-sagara/jageocoder-converter).
 
+## Sample Web Application
+
+A sample of a simple web app using Flask is available under
+`flask-demo`.
+
+Perform the following steps. Then, access port 5000.
+
+```
+cd flask-demo
+pip install flask
+bash run.sh
+```
+
 ## ToDos
 
 - Supporting address changes

diff --git a/README_ja.md b/README_ja.md
@@ -118,6 +118,18 @@ python -m unittest
 
 [jageocoder-converter](https://github.com/t-sagara/jageocoder-converter).
 
+## サンプルウェブアプリ
+
+Flask を利用したシンプルなウェブアプリのサンプルが
+`flask-demo` の下にあります。
+
+次の手順を実行し、ポート 5000 にアクセスしてください。
+
+```
+cd flask-demo
+pip install flask
+bash run.sh
+```
 
 ## ToDo
 

diff --git a/flask-demo/app.py b/flask-demo/app.py
@@ -0,0 +1,22 @@
+from flask import Flask, request, render_template
+
+import jageocoder
+jageocoder.init()
+
+app = Flask(__name__)
+
+
+@app.route("/")
+def index():
+    return render_template('index.html', q='', result=None)
+
+
+@app.route("/search", methods=['POST', 'GET'])
+def search():
+    query = request.args.get('q') or None
+    if query:
+        results = jageocoder.searchNode(query, best_only=True)
+    else:
+        results = None
+
+    return render_template('index.html', q=query, results=results)
diff --git a/flask-demo/run.sh b/flask-demo/run.sh
@@ -0,0 +1,4 @@
+#!bash
+export FLASK_APP=app
+export FLASK_ENV=development
+flask run --host=0.0.0.0
diff --git a/flask-demo/templates/index.html b/flask-demo/templates/index.html
@@ -0,0 +1,74 @@
+<!doctype html>
+<html lang="ja">
+  <head>
+    <meta charset="utf-8" />
+    <title>Jageocoder Flask Demonstration</title>
+  </head>
+  <body>
+    <h1>Jageocoder のデモンストレーション</h1>
+    <form action="/search" method="GET">
+      検索したい住所を入力：<br />
+      <input size="80" value="{{ q }}" name="q" />
+      <input type="submit" value="検索" />
+    </form>
+
+    {% if results %}
+    <p>結果一覧 <a href="/">住所の例に戻る</a></p>
+    <ul id="results">
+      {% for result in results %}
+        <li class="node">
+          {% for name in result.node.get_fullname() %}
+          {{ name }}<nbsp;>
+          {% endfor %}
+          <ul>
+            <li>一致した文字列： {{ result.matched }}</li>
+            <li>座標：
+              経度 {{ result.node.x }}, 緯度 {{ result.node.y }}
+              <a href="{{ result.node.get_gsimap_link() }}" target="_gsimap">地理院地図</a></li>
+          </ul>
+        </li>
+      {% endfor %}
+    </ul>
+    {% else %}
+    <p>住所の例</p>
+    <ul>
+      <li><dl>
+        <dt>多摩市落合1-15多摩センタートーセイビル</dt>
+        <dd>「番」「番地」をハイフンや「の」などで省略しても解析できます。ビル・マンション名には対応していません。</dd>
+      </dl></li>
+      <li><dl>
+        <dt>茨城県竜ヶ崎市字米町3903</dt>
+        <dd>「竜」と「龍」などの異体字に対応しています。</dd>
+      </dl></li>
+      <li><dl>
+        <dt>中央区中央1</dt>
+        <dd>都道府県名や市区町村名の省略に対応しています。候補が複数見つかった場合は複数の結果を返します。</dd>
+      </dl></li>
+      <li><dl>
+        <dt>東京都西多摩郡瑞穂町箱根ケ崎2335番地</dt>
+        <dd>大字名の「大字」の省略に対応しています。</dd>
+      </dl></li>
+      <li><dl>
+        <dt>埼玉県大里郡寄居町大字鷹巣</dt>
+        <dd>「鷹ノ巣」の「ノ」などの省略に対応しています。</dd>
+      </dl></li>
+      <li><dl>
+        <dt>札幌市中央区北3西1-7</dt>
+        <dd>札幌市の「北三条西一丁目」を「北3西1」のように省略する表記に対応しています。</dd>
+      </dl></li>
+      <li><dl>
+        <dt>京都市上京区下立売通新町西入薮ノ内町</dt>
+        <dd>京都市の通り名には部分的に対応していて、通り名部分をスキップして町名から処理します。</dd>
+      </dl></li>
+      <li><dl>
+        <dt>長野県千曲市礒部字下河原１１３７</dt>
+        <dd>辞書にない字名が含まれていても、対応する地番を検索します。</dd>
+      </dl></li>
+      <li><dl>
+        <dt>福島県いわき市平上高久塚田97乙</dt>
+        <dd>地番の脱落地に対応しています。</dd>
+      </dl></li>
+    </ul>
+    {% endif %}
+  </body>
+</html>
diff --git a/jageocoder/__init__.py b/jageocoder/__init__.py
@@ -19,7 +19,7 @@
     >>> jageocoder.searchNode('<Japanese-address>')
 """
 
-__version__ = '1.0.0rc2'  # The package version
+__version__ = '1.0.0'  # The package version
 __dictionary_version__ = '20211209'  # Compatible dictionary version
 __author__ = 'Takeshi Sagara <[email protected]>'
 

diff --git a/jageocoder/node.py b/jageocoder/node.py
@@ -521,3 +521,13 @@ def _local_authority_code(self, orig_code: str) -> str:
             checkdigit = str(11 - remainder)[-1]
 
         return orig_code + checkdigit
+
+    def get_gsimap_link(self) -> str:
+        """
+        Returns the URL for GSI Map with parameters.
+        ex. https://maps.gsi.go.jp/#13/35.713556/139.750385/
+        """
+        url = 'https://maps.gsi.go.jp/#{level:d}/{lat:.6f}/{lon:.6f}/'
+        return url.format(
+            level=9 + self.level,
+            lat=self.y, lon=self.x)
diff --git a/tests/test_search.py b/tests/test_search.py
@@ -444,6 +444,14 @@ def test_select_best(self):
             match="佐賀県鹿島市納富分字藤津甲",
             fullname=["佐賀県", "鹿島市", "大字納富分", "藤津甲"])
 
+    def test_datsurakuchi(self):
+        """
+        """
+        self._check(
+            query="福島県いわき市平上高久塚田97乙",
+            fullname=["福島県", "いわき市", "平上高久",
+                      "塚田", "97番", "乙地"])
+
 
 if __name__ == "__main__":
     unittest.main()