pyreinfolib 0.1.0__tar.gz

pyreinfolib-0.1.0/.github/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.1.0"
+}

pyreinfolib-0.1.0/.github/release-please-config.json

@@ -0,0 +1,13 @@
+{
+  "release-type": "python",
+  "bump-minor-pre-major": true,
+  "initial-version": "0.1.0",
+  "include-component-in-tag": false,
+  "packages": {
+    ".": {
+      "release-type": "python"
+    }
+  },
+  "pull-request-title-pattern": "chore: release ${version}",
+  "$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json"
+}

pyreinfolib-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,53 @@
+name: Publish Python distribution to PyPI
+
+on:
+  workflow_call:
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Install build dependencies
+        run: |
+          python -m pip install --upgrade pip 
+          pip install hatch
+
+      - name: Build package
+        run: hatch build
+
+      - name: Store the distribution packages
+        uses: actions/upload-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+  publish-to-pypi:
+    name: Publish distribution 📦 to PyPI
+    if: startsWith(github.ref, 'refs/tags/')  # only publish to PyPI on tag pushes
+    needs:
+      - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/pyreinfolib
+    permissions:
+      id-token: write
+    steps:
+      - name: Download all the dists
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Publish distribution 📦 to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

pyreinfolib-0.1.0/.github/workflows/release-please.yml

@@ -0,0 +1,28 @@
+name: release-please
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    outputs:
+      release_created: ${{ steps.release.outputs.release_created }}
+    steps:
+      - name: release-please
+        id: release
+        uses: googleapis/release-please-action@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          config-file: .github/release-please-config.json
+          manifest-file: .github/.release-please-manifest.json
+  publish:
+    needs: release-please
+    if: ${{ needs.release-please.outputs.release_created }}
+    uses: "./.github/workflows/publish.yml"

pyreinfolib-0.1.0/.gitignore

@@ -0,0 +1,161 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# InelliJ
+.idea/
+
+# MacOS
+.DS_Store

pyreinfolib-0.1.0/.python-version

@@ -0,0 +1 @@
+3.12.2

pyreinfolib-0.1.0/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+
+## [0.1.0](https://github.com/matsudan/pyreinfolib/compare/v0.1.0...v0.1.0) (2024-11-23)
+
+
+### Features
+
+* add client class ([989f0cb](https://github.com/matsudan/pyreinfolib/commit/989f0cb6b440fba08169b315a6e6db5ab95611fb))
+* add get_appraisal_reports method ([4a246c3](https://github.com/matsudan/pyreinfolib/commit/4a246c3235db378451deaa2e7a4f7cd7284ac912))
+* add get_land_price_public_notices_and_surveys_point method ([a1cae6a](https://github.com/matsudan/pyreinfolib/commit/a1cae6af60b180309f5aa59b49cd11c0a24f5d98))
+* add get_real_estate_price_point method ([6bac4fa](https://github.com/matsudan/pyreinfolib/commit/6bac4fa101bbe00bca285a22045f804fd97787ab))
+* add get_real_estate_prices method ([27b7894](https://github.com/matsudan/pyreinfolib/commit/27b78947fbcb5074d3ae70f2495b50e08b7504b4))
+* add landTypeCode enum ([837d031](https://github.com/matsudan/pyreinfolib/commit/837d03158ff7960f91c892ce525119105eeece93))
+* add UseDivision enum ([df1f213](https://github.com/matsudan/pyreinfolib/commit/df1f213e717fc7fd57906b201050d68b7f2b9107))
+
+
+### Bug Fixes
+
+* fix area argument type of get_municipalities method to str ([2594a17](https://github.com/matsudan/pyreinfolib/commit/2594a17eb1a0ecea271d865dee981788abdc27dd))
+* fix get method name in each api method ([d6031b3](https://github.com/matsudan/pyreinfolib/commit/d6031b37f4467f06ff501ebaa38cc1a7a667a542))
+* fix to add trailing slash to the end of base url ([350af78](https://github.com/matsudan/pyreinfolib/commit/350af789c65399e477b0075c1d77e49e6f9d1a1a))
+* fix to use urljoin for api_url ([f8842b8](https://github.com/matsudan/pyreinfolib/commit/f8842b8999993d47401582c02167b762a615446f))

pyreinfolib-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 matsudan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pyreinfolib-0.1.0/PKG-INFO

@@ -0,0 +1,57 @@
+Metadata-Version: 2.3
+Name: pyreinfolib
+Version: 0.1.0
+Summary: Python client for Real Estate Information Library APIs
+Project-URL: Homepage, https://github.com/matsudan/pyreinfolib
+Author-email: matsudan <daaamatsun@gmail.com>
+Keywords: api,client,real-estate
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.11
+Requires-Dist: requests
+Description-Content-Type: text/markdown
+
+# pyreinfolib
+
+国土交通省[不動産情報ライブラリ](https://www.reinfolib.mlit.go.jp/)APIサービスのPythonクライアントです。API仕様についての詳細は[API操作説明ページ](https://www.reinfolib.mlit.go.jp/help/apiManual/)をご参照ください。
+
+## Installation
+
+```
+
+```
+
+### Supported Python Versions
+
+Python >= 3.11
+
+## Usage
+
+```python
+from pyreinfolib import Client
+
+client = Client(api_key="<your api key>")
+```
+
+## Example
+
+### 不動産価格（取引価格・成約価格）情報
+
+```python
+client.get_real_estate_prices(year=2024, quarter=1, price_classification="01", city="13109")
+```
+
+### 鑑定評価書情報
+
+```python
+from pyreinfolib.enums import UseDivision
+
+client.get_appraisal_reports(year=2024, area="13", division=UseDivision.INDUSTRIAL_LAND)
+```
+
+## Author
+
+@matsudan (daaamatsun@gmail.com)

pyreinfolib-0.1.0/README.md

@@ -0,0 +1,41 @@
+# pyreinfolib
+
+国土交通省[不動産情報ライブラリ](https://www.reinfolib.mlit.go.jp/)APIサービスのPythonクライアントです。API仕様についての詳細は[API操作説明ページ](https://www.reinfolib.mlit.go.jp/help/apiManual/)をご参照ください。
+
+## Installation
+
+```
+
+```
+
+### Supported Python Versions
+
+Python >= 3.11
+
+## Usage
+
+```python
+from pyreinfolib import Client
+
+client = Client(api_key="<your api key>")
+```
+
+## Example
+
+### 不動産価格（取引価格・成約価格）情報
+
+```python
+client.get_real_estate_prices(year=2024, quarter=1, price_classification="01", city="13109")
+```
+
+### 鑑定評価書情報
+
+```python
+from pyreinfolib.enums import UseDivision
+
+client.get_appraisal_reports(year=2024, area="13", division=UseDivision.INDUSTRIAL_LAND)
+```
+
+## Author
+
+@matsudan (daaamatsun@gmail.com)

pyreinfolib-0.1.0/pyproject.toml

@@ -0,0 +1,58 @@
+[project]
+name = "pyreinfolib"
+description = "Python client for Real Estate Information Library APIs"
+authors = [
+    { name = "matsudan", email = "daaamatsun@gmail.com" }
+]
+dynamic = ["version"]
+dependencies = [
+    "requests",
+]
+readme = "README.md"
+requires-python = ">= 3.11"
+classifiers = [
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+keywords = ["real-estate", "api", "client"]
+
+[project.urls]
+Homepage = "https://github.com/matsudan/pyreinfolib"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.rye]
+managed = true
+dev-dependencies = [
+    "ruff>=0.7.4",
+    "pytest>=8.3.3",
+]
+
+[tool.hatch.metadata]
+allow-direct-references = true
+
+[tool.hatch.build.targets.wheel]
+packages = ["pyreinfolib"]
+
+[tool.hatch.version]
+path = "pyreinfolib/__init__.py"
+
+[tool.ruff]
+line-length = 120
+indent-width = 4
+target-version = "py312"
+
+[tool.ruff.lint]
+select = ["F", "E", "W", "I", "Q"]
+fixable = ["ALL"]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "auto"

pyreinfolib-0.1.0/pyreinfolib/__init__.py

@@ -0,0 +1,3 @@
+from .client import Client # noqa
+
+__version__ = "0.1.0"

pyreinfolib-0.1.0/pyreinfolib/client.py

@@ -0,0 +1,150 @@
+import logging
+from typing import Literal
+from urllib.parse import urljoin
+
+import requests
+
+from pyreinfolib import enums
+
+logger = logging.getLogger(__name__)
+
+class Client:
+    def __init__(self, api_key: str):
+        self.api_key = api_key
+        self.base_url = "https://www.reinfolib.mlit.go.jp/ex-api/external/"
+
+    def _get(self, endpoint: str, params: dict = None) -> dict:
+
+        api_url = urljoin(self.base_url, endpoint)
+        headers = {"Ocp-Apim-Subscription-Key": self.api_key}
+        try:
+            r = requests.get(api_url, headers=headers, params=params)
+            r.raise_for_status()
+            return r.json()
+        except requests.RequestException as e:
+            logger.error(f"Request failed for {api_url} with error: {e.response.text}")
+            raise
+
+    def get_real_estate_prices(
+        self,
+        year: int,
+        price_classification: Literal["01", "02"] = None,
+        quarter: Literal[1, 2, 3, 4] = None,
+        area: str = None,
+        city: str = None,
+        station: str = None,
+        language: Literal["ja", "en"] = None
+    ) -> dict:
+        """Get real estate prices. See https://www.reinfolib.mlit.go.jp/help/apiManual/#titleApi4 for details.
+        :param price_classification: Price classification code.
+          01: Real estate transaction price information, 02: Contract price information,
+          Unspecified: Both transaction price information and contract price information.
+        :param year: Transaction period (Year).
+        :param quarter: Transaction period (Quarter). 1: Jan.~Mar. 2: Apr.~Jun. 3: Jul.~Sep. 4: Oct.~Dec.
+        :param area: Prefecture code. See https://nlftp.mlit.go.jp/ksj/gml/codelist/PrefCd.html
+        :param city: Municipality code.
+        :param station: Station code. See https://nlftp.mlit.go.jp/ksj/gml/datalist/KsjTmplt-N02-v3_1.html
+        :param language: `ja` or `en`. If not specified, `ja`.
+        :return: Real estate prices.
+        """
+        params = {"year": year}
+        if price_classification:
+            params["priceClassification"] = price_classification
+        if quarter:
+            params["quarter"] = quarter
+        if area:
+            params["area"] = area
+        if city:
+            params["city"] = city
+        if station:
+            params["station"] = station
+        if language:
+            params["language"] = language
+
+        return self._get("XIT001", params)
+
+    def get_municipalities(self, area: str, language: Literal["ja", "en"] = None) -> dict:
+        """Get municipality (city/ward/town/village) list.
+        See https://www.reinfolib.mlit.go.jp/help/apiManual/#titleApi5 for details.
+        :param area: Prefecture code. See https://nlftp.mlit.go.jp/ksj/gml/codelist/PrefCd.html
+        :param language: `ja` or `en`. If not specified, `ja`.
+        :return: Municipality list.
+        """
+        params = {"area": area}
+        if language:
+            params.update(language=language)
+
+        return self._get("XIT002", params)
+
+    def get_appraisal_reports(self, year: int, area: str, division: enums.UseDivision):
+        """Get real estate appraisal reports.
+        See https://www.reinfolib.mlit.go.jp/help/apiManual/#titleApi6 for details.
+        :param year: Date of value.
+        :param area: Prefecture code.
+        :param division: Use division.
+        :return: Real estate appraisal reports.
+        """
+        params = {"year": year, "area": area, "division": division}
+
+        return self._get("XCT001", params)
+
+    def get_real_estate_prices_point(
+        self,
+        z: int,
+        x: int,
+        y: int,
+        period_from: int,
+        period_to: int,
+        price_classification: Literal["01", "02"] = None,
+        land_type_code: list[enums.LandTypeCode] = None,
+    ) -> dict:
+        """Get real estate prices point.
+        See https://www.reinfolib.mlit.go.jp/help/apiManual/#titleApi7 for details.
+        :param z: Zoom level (scale). 11 (city) ~ 15 (detail)
+        :param x: x value of tile coordinates.
+        :param y: y value of tile coordinates.
+        :param period_from: Transaction period from. Format: YYYYN. e.g. 20241
+        :param period_to: Transaction period to. Format: YYYYN. e.g. 20242
+        :param price_classification: Price classification code.
+          01: Real estate transaction price information, 02: Contract price information,
+          Unspecified: Both transaction price information and contract price information.
+        :param land_type_code: Land type code. See https://www.reinfolib.mlit.go.jp/help/apiManual/#titleApi7
+        :return: Real estate prices point. (Response format: GeoJson)
+        """
+        params = {"response_format": "geojson", "z": z, "x": x, "y": y, "from": period_from, "to": period_to}
+        if price_classification:
+            params["priceClassification"] = price_classification
+        if land_type_code:
+            params["landTypeCode"] = ",".join(land_type_code)
+
+        return self._get("XPT001", params)
+
+    def get_land_price_public_notices_and_surveys_point(
+        self,
+        z: Literal[13,14,15],
+        x: int,
+        y: int,
+        year: int,
+        price_classification: Literal["0", "1"] = None,
+        use_category_code: list[enums.UseDivision] = None,
+    ) -> dict:
+        """Get land price public notices (standard land prices) and
+        prefectural land price surveys (benchmark land prices) point.
+        See https://www.reinfolib.mlit.go.jp/help/apiManual/#titleApi8 for details.
+        :param z: Zoom level (scale). 13 ~ 15 (detail)
+        :param x: x value of tile coordinates.
+        :param y: y value of tile coordinates.
+        :param year: target year.
+        :param price_classification: Land price classification code.
+          0: Land price public notices, 1: Prefectural land price surveys, Unspecified: Both 0 and 1.
+        :param use_category_code: Use division code. See https://www.reinfolib.mlit.go.jp/help/apiManual/#titleApi8
+        :return: land price public notices (standard land prices) and
+        prefectural land price surveys (benchmark land prices) point. (Response format: GeoJson)
+        """
+        params = {"response_format": "geojson", "z": z, "x": x, "y": y, "year": year}
+        if price_classification:
+            params["priceClassification"] = price_classification
+        if use_category_code:
+            params["useCategoryCode"] = ",".join(use_category_code)
+
+        return self._get("XPT002", params)

pyreinfolib-0.1.0/pyreinfolib/enums.py

@@ -0,0 +1,45 @@
+from enum import StrEnum, unique
+
+
+@unique
+class UseDivision(StrEnum):
+    # 住宅地
+    RESIDENTIAL_LAND = "00"
+
+    # 宅地見込地
+    BUILDING_SITE_WITH_AN_INTERIM_USE = "03"
+
+    # 商業地
+    COMMERCIAL_LAND = "05"
+
+    # 準工業地
+    QUASI_INDUSTRIAL_LAND = "07"
+
+    # 工業地
+    INDUSTRIAL_LAND = "09"
+
+    # 調整区域内宅地
+    BUILDING_SITE_WITHIN_URBANIZATION_CONTROL_AREA = "10"
+
+    # 現況林地
+    CURRENT_FOREST_LAND = "13"
+
+    # 林地（都道府県地価調査）
+    FOREST_LAND = "20"
+
+@unique
+class LandTypeCode(StrEnum):
+    # 宅地(土地)
+    LAND = "01"
+
+    # 宅地(土地と建物)
+    LAND_AND_BUILDING = "02"
+
+    # 中古マンション等
+    PRE_OWNED_CONDOMINIUMS_ETC = "07"
+
+    # 農地
+    AGRICULTURAL_LAND = "10"
+
+    # 林地
+    FOREST_LAND = "11"

pyreinfolib-0.1.0/pyreinfolib/test.py

@@ -0,0 +1,26 @@
+from pyreinfolib import Client
+from pyreinfolib.enums import UseDivision, LandTypeCode
+
+c = Client("5d1cf2e03da64b6db532b25f366d8a49")
+# res1 = c.get_municipalities(area=13)
+# print(res1)
+
+#res2 = c.get_real_estate_prices(year=2024, quarter=5, price_classification="01", city="13109")
+# print(res2)
+
+# res3 = c.get_appraisal_reports(year=2024, area="13", division=UseDivision.INDUSTRIAL_LAND)
+# print(res3)
+
+res4 = c.get_real_estate_prices_point(
+    z=11, x=1819, y=806, period_from=20241, period_to=20241,price_classification="01",
+    land_type_code=[
+        LandTypeCode.LAND,
+        LandTypeCode.FOREST_LAND,
+    ]
+)
+#print(res4)
+
+# res5 = c.get_land_price_public_notices_and_surveys_point(
+#     z=13, x=7312, y=3008,year=2020,price_classification="0",use_category_code=[UseDivision.RESIDENTIAL_LAND]
+# )
+# print(res5)

pyreinfolib-0.1.0/requirements-dev.lock

@@ -0,0 +1,30 @@
+# generated by rye
+# use `rye lock` or `rye sync` to update this lockfile
+#
+# last locked with the following flags:
+#   pre: false
+#   features: []
+#   all-features: false
+#   with-sources: false
+#   generate-hashes: false
+#   universal: false
+
+-e file:.
+certifi==2024.8.30
+    # via requests
+charset-normalizer==3.4.0
+    # via requests
+idna==3.10
+    # via requests
+iniconfig==2.0.0
+    # via pytest
+packaging==24.2
+    # via pytest
+pluggy==1.5.0
+    # via pytest
+pytest==8.3.3
+requests==2.32.3
+    # via pyreinfolib
+ruff==0.7.4
+urllib3==2.2.3
+    # via requests

pyreinfolib-0.1.0/requirements.lock

@@ -0,0 +1,22 @@
+# generated by rye
+# use `rye lock` or `rye sync` to update this lockfile
+#
+# last locked with the following flags:
+#   pre: false
+#   features: []
+#   all-features: false
+#   with-sources: false
+#   generate-hashes: false
+#   universal: false
+
+-e file:.
+certifi==2024.8.30
+    # via requests
+charset-normalizer==3.4.0
+    # via requests
+idna==3.10
+    # via requests
+requests==2.32.3
+    # via pyreinfolib
+urllib3==2.2.3
+    # via requests

pyreinfolib-0.1.0/tests/test_client.py

@@ -0,0 +1,38 @@
+from dataclasses import dataclass
+import pytest
+from unittest.mock import patch
+
+from pyreinfolib import Client
+
+@dataclass
+class GetMunicipalitiesArgs:
+    area: int
+    language: str
+
+@dataclass
+class GetMunicipalitiesTestCase:
+    args: GetMunicipalitiesArgs
+    expected: dict
+    error: Exception | None
+
+@pytest.mark.parametrize(
+    ["test_case"],
+    [
+        pytest.param(
+            GetMunicipalitiesTestCase(
+                args=GetMunicipalitiesArgs(
+                    area=13,
+                    language="ja",
+                ),
+                expected={"status": "OK", "data": [{"id": "13101", "name": "千代田区"}]},
+                error=None,
+            ),
+            id="normal"
+        )
+    ]
+)
+@patch('pyreinfolib.Client')
+def get_municipalities():
+    client = Client(api_key="dummy")
+
+