hotpepper-gourmet-tddschn
About
Fork of hotpepper-gourmet package on pypi (https://github.com/paperlefthand/hotpepper-gourmet) that uses https instead of http.
ホットペッパーグルメAPIのシンプルなクライアントライブラリです
API Coverage
This library now covers all official Hotpepper Gourmet endpoints (12/12).
| API (Official) | Python method (sync / async) |
|---|---|
| Gourmet Search | search / search_async |
| Shop Name Search | name_search / name_search_async |
| Budget Master | budget_master / budget_master_async |
| Large Service Area Master | large_service_area_master / large_service_area_master_async |
| Service Area Master | service_area_master / service_area_master_async |
| Large Area Master | large_area_master / large_area_master_async |
| Middle Area Master | middle_area_master / middle_area_master_async |
| Small Area Master | small_area_master / small_area_master_async |
| Genre Master | genre_master / genre_master_async |
| Credit Card Master | credit_card_master / credit_card_master_async |
| Special Master | special_master / special_master_async |
| Special Category Master | special_category_master / special_category_master_async |
Language Notation (Japan topics)
In this project, when we reference Japan-related proper nouns or useful markers, we include:
- Japanese + Romaji (e.g., 東京, Tōkyō)
- zh_TW for kana terms (e.g., グルメ, gurume, 美食)
- Original language for katakana transliterations (e.g., ホットペッパー, Hotto Peppaa, Hot Pepper)
Examples:
- 東京 (とうきょう, Tōkyō, 東京)
- 新宿 (しんじゅく, Shinjuku, 新宿)
- ラーメン (raamen, 拉麵, ramen)
- ジャンル (janru, 類型, genre)
How To Use
keyidの取得
ホットペッパーグルメAPIに登録し, token(keyid)を取得
CLI利用時は環境変数 HOTPEPPER_API_KEY を使用します:
export HOTPEPPER_API_KEY="YOUR_KEYID"
サンプルコード
同期版
>>> from pygourmet import Api, Option
>>> api = Api(keyid=YOUR_KEYID)
>>> option = Option(lat=35.170915, lng=136.8793482, keyword="ラーメン", range=4, count=3)
>>> shops = api.search(option)
>>> len(shops)
3
>>> shops[0].name
'shop name'
複数値クエリと拡張レスポンス (type=special+credit_card) の例:
from pygourmet import Api, Option
api = Api(keyid="YOUR_KEYID")
option = Option(
keyword="焼肉",
large_area=["Z011", "Z012"],
budget=["B001", "B002"],
type=["special", "credit_card"],
)
shops = api.search(option)
first = shops[0]
# `type=special+credit_card` を指定した場合もモデルで取得可能
if first.special:
print(first.special[0].name)
if first.credit_card:
print(first.credit_card[0].name)
マスタAPIの例(ジャンル + 大エリア):
from pygourmet import Api, GenreMasterOption, LargeAreaMasterOption
api = Api(keyid="YOUR_KEYID")
genres = api.genre_master(GenreMasterOption(keyword="居酒屋"))
areas = api.large_area_master(LargeAreaMasterOption(keyword="東京"))
print(genres[0].code, genres[0].name)
print(areas[0].code, areas[0].name)
非同期版
async def call_search_async():
shops = await api.search_async(option=option)
print(len(shops))
loop = asyncio.get_event_loop()
loop.run_until_complete(call_search_async())
CLI: hotpepper-cli
インストール後は hotpepper-cli コマンドが利用できます.
グルメ検索(東京 / とうきょう / Tōkyō / 東京):
hotpepper-cli search --keyword "ラーメン" --large-area Z011 --count 5
店名サーチ(新宿 / しんじゅく / Shinjuku / 新宿):
hotpepper-cli name-search --keyword 新宿 --count 10
ジャンルマスタ取得(JSON出力):
hotpepper-cli -j genre --keyword 居酒屋
特集カテゴリ取得:
hotpepper-cli special-category
補足:
-j,--json: JSONを標準出力- 省略時は Rich テーブルで整形表示
- APIキーは
--api-keyで直接指定も可能
開発者向けガイド
このリポジトリは uv によるパッケージ管理を採用しています. Python バージョンは 3.12, 3.13, 3.14 をサポート対象としています.
セットアップ
# 依存関係のインストール(開発環境構築)
uv sync
よく使うコマンド
原則として uv run を介して実行します.
# テスト実行
uv run pytest -v
# 統合テスト実行(要 HOTPEPPER_KEYID 環境変数)
# ローカル環境でのみ実行し、APIキーを利用して実際にリクエストを送ります
uv run pytest --run-integration
# 静的型チェック
uv run ty check
# Lint チェック
uv run ruff check .
# コードフォーマット適用
uv run ruff format .
# コミット前チェック(Lint/Format/TypeCheck 等を一括実行)
uv run prek
# API ドキュメント生成
uv run pdoc src/pygourmet
# 特定バージョンの動作確認(tox)
uv run tox -e py314
コーディング規約
- Style: Ruff 準拠 (4スペースインデント, ダブルクォート, スネークケース). クラス名は PascalCase.
- Docstring: Google Style.
- Type: Pydantic v2 を活用し,
Anyを排除した厳格な型注釈を行う.
テストガイドライン
- 基本:
pytest+pytest-httpx(モック). - 統合テスト:
@pytest.mark.integrationを付与.uv run pytest --run-integrationでのみ実行される. - 非同期:
pytest-asyncioを使用.
コミット・PRガイドライン
- コミットメッセージは Conventional Commits 形式.
- コミット前に必ず
uv run prekをパスさせること. - PR には変更の目的, テスト結果, ドキュメント更新の有無を記載.
CI/CD
- CI: GitHub Actions +
tox-uv(Python 3.12, 3.13, 3.14). - TestPyPI:
devブランチへの push で自動デプロイ. - PyPI / Docs:
v*タグ (例:v1.0.0) の push で本番リリースおよび GitHub Pages 更新.
セキュリティ
- API Key (
HOTPEPPER_KEYID) は絶対コミットしない. - ローカル開発では
.envを利用する (python-dotenv対応).
Powered by ホットペッパー Webサービス
Metadata
Release files for hotpepper-gourmet-tddschn 0.0.8
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| hotpepper_gourmet_tddschn-0.0.8.tar.gz | 79.6 kB | Without provenance | Details for hotpepper_gourmet_tddschn-0.0.8.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| hotpepper_gourmet_tddschn-0.0.8-py3-none-any.whl | Python 3 | none | any | Details for hotpepper_gourmet_tddschn-0.0.8-py3-none-any.whl |
Total release size: 100.8 kB
Release files / hotpepper_gourmet_tddschn-0.0.8.tar.gz
| Download URL | hotpepper_gourmet_tddschn-0.0.8.tar.gz |
|---|---|
| Size | 79.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
413d4753aca81add3687d7c69568671fca83b762958c0b75be16d6d17b179ba3
|
|
BLAKE2b-256 checksum How to use checksums |
9f2df20d8ee0d37a8001ba4718c4cf7afbb18176047556f86128a93c07d9c674
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.10.4 {"installer":{"name":"uv","version":"0.10.4","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Release files / hotpepper_gourmet_tddschn-0.0.8-py3-none-any.whl
| Download URL | hotpepper_gourmet_tddschn-0.0.8-py3-none-any.whl |
|---|---|
| Size | 21.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f11db852fc3cf17de4a49c351292e613e4daf08dc058cd2435c0e896e52a765d
|
|
BLAKE2b-256 checksum How to use checksums |
5759466508b4a3117d108c561a8f3cae4f0f0325af2412a42057974b71a846d3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.10.4 {"installer":{"name":"uv","version":"0.10.4","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Security for hotpepper-gourmet-tddschn 0.0.8
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.