Repolode
cloudflare

cloudflare/cloudflare-python

Cloudflare REST API公式Python SDK。同期・非同期クライアントを備え、リクエストとレスポンスは型定義付きです。

スター
516
フォーク
159
未解決の Issue
33
最終コミット
昨日

これは何?

cloudflare-pythonは、Cloudflare REST APIの公式Pythonクライアントです。手書きのHTTPリクエストではなくメソッド呼び出しで、ゾーン、アカウント、KVネームスペースなどのCloudflareリソースをPythonコードから管理できます。Python 3.9以降に対応し、すべてのリクエストパラメーターとレスポンスフィールドの型定義が用意されています。

同期クライアント(Cloudflare)と非同期クライアント(AsyncCloudflare)があり、どちらもhttpxをベースにしています。非同期クライアントでは、オプションでaiohttpバックエンドも利用できます。リスト取得メソッドは自動ページネーション対応のイテレーターを返し、ファイルのアップロードではbytes、パス、または(ファイル名、内容、メディアタイプ)のタプルを指定できます。レスポンスはPydanticモデルで、to_json()とto_dict()ヘルパーを備えています。

指数バックオフによる再試行、リクエストごとのタイムアウト、HTTPステータスに基づく型付き例外階層を設定できます。また、生レスポンスやストリーミングレスポンスにもアクセスできます。コードはStainlessで生成されており、ドキュメントに記載されていないエンドポイントもクライアントのgetメソッドやpostメソッドから呼び出せます。

主な機能

  • 01Cloudflare REST API向けの同期・非同期クライアント。
  • 02リクエストパラメーターとレスポンスフィールドの型定義、およびPydanticレスポンスモデル。
  • 03リストエンドポイント向けの自動ページネーション対応イテレーター。
  • 04指数バックオフによる自動再試行、設定可能なタイムアウト、ステータスコードに基づく例外階層。
  • 05非同期クライアント用のオプションのaiohttpバックエンド。

ユースケース

  • Pythonスクリプトやインフラ管理ツールからDNSやゾーンの設定を自動化する。
  • 非同期PythonサービスからCloudflareアカウントやKVデータを管理する。
  • 型付けされたコードベースで、エディターの自動補完を活用しながらCloudflare APIエンドポイントを呼び出す。

クイックスタート

  1. 1

    PyPIからライブラリをインストールする

    pip install cloudflare
  2. 2

    APIトークンを使ってクライアントを作成し、APIを呼び出す

使う前に知っておきたいこと

  • リクエストを送信するにはCloudflare APIトークンが必要です。
  • Python 3.9以降が必要です。

収録されている特集

トピック

よくある質問

cloudflare-python とは?
Cloudflare REST API公式Python SDK。同期・非同期クライアントを備え、リクエストとレスポンスは型定義付きです。 cloudflare-pythonは、Cloudflare REST APIの公式Pythonクライアントです。手書きのHTTPリクエストではなくメソッド呼び出しで、ゾーン、アカウント、KVネームスペースなどのCloudflareリソースをPythonコードから管理できます。Python 3.9以降に対応し、すべてのリクエストパラメーターとレスポンスフィールドの型定義が用意されています。
cloudflare-python は無料で使えますか?ライセンスは?
cloudflare-python は Apache-2.0 ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。
cloudflare-python は今もメンテナンスされていますか?
活発にメンテナンス中。cloudflare-python の最終コミットは 2026年11月5日 です。
cloudflare-python は何に使えますか?
Pythonスクリプトやインフラ管理ツールからDNSやゾーンの設定を自動化する。 非同期PythonサービスからCloudflareアカウントやKVデータを管理する。 型付けされたコードベースで、エディターの自動補完を活用しながらCloudflare APIエンドポイントを呼び出す。
cloudflare-python のインストール方法は?
PyPIからライブラリをインストールする: pip install cloudflare APIトークンを使ってクライアントを作成し、APIを呼び出す
cloudflare-python はどこで入手できますか?
ソースコードとインストール手順は GitHub にあります:https://github.com/cloudflare/cloudflare-python

概要はプロジェクトの README をもとに AI が生成しています。GitHub の数値は毎日更新されます。

関連プロジェクト