hotpepper-gourmet
About
ホットペッパーグルメAPIのシンプルで型安全なクライアントライブラリです.
- 同期・非同期の両方の検索 API を提供
- リクエストパラメータ・レスポンスを Pydantic v2 のモデルとして扱える
- API ドキュメント: https://paperlefthand.github.io/hotpepper-gourmet/
Install
pip install hotpepper-gourmet
# または
uv add hotpepper-gourmet
Python 3.12, 3.13, 3.14 をサポートしています.
How To Use
keyidの取得
ホットペッパーWebサービスに登録し, APIキー(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'
非同期版
import asyncio
from pygourmet import Api, Option
async def main() -> None:
api = Api(keyid=YOUR_KEYID)
option = Option(keyword="寿司", count=3)
shops = await api.search_async(option)
print(len(shops))
asyncio.run(main())
エラー時は pygourmet.SearchError が送出されます.
コントリビューション
バグ報告・機能要望・Pull Request を歓迎します. 開発環境の構築方法や PR の出し方は CONTRIBUTING.md を参照してください.
- 変更履歴: GitHub Releases
- 行動規範: CODE_OF_CONDUCT.md
- 脆弱性の報告: SECURITY.md
License
Powered by ホットペッパー Webサービス
1 maintainer
Metadata
1 maintainer
Release files for hotpepper-gourmet 0.0.6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| hotpepper_gourmet-0.0.6.tar.gz | 77.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| hotpepper_gourmet-0.0.6-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 89.6 kB
Release files / hotpepper_gourmet-0.0.6.tar.gz
| Download URL | hotpepper_gourmet-0.0.6.tar.gz |
|---|---|
| Size | 77.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
81ee7b9d55047ebafca9002ea298c04058cfc6171cd5a4486098a3289c5e445a
|
|
BLAKE2b-256 checksum How to use checksums |
9ffd53f74729ba42087e3229ed2e0735cef3645cbc277ea1989e74883272a697
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 13, 2026.
Transparency logRelease files / hotpepper_gourmet-0.0.6-py3-none-any.whl
| Download URL | hotpepper_gourmet-0.0.6-py3-none-any.whl |
|---|---|
| Size | 12.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
bfe4f398a36b01b4540175531ef518696cbcde7b085588dc474b8ae208cad030
|
|
BLAKE2b-256 checksum How to use checksums |
8bd63091dc15dcdc09055bcad11be894b536b9729003dfe22cd314896ed31bdf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 13, 2026.
Transparency log
