Censys Python ライブラリ

[!WARNING] 非推奨のお知らせ: Censys Search v1 および v2 API はまもなく非推奨となります。新しい Censys Platform への移行をお願いします。

📖 新しい API ドキュメント: https://docs.censys.com/reference/get-started

📦 新しい Python SDK: censys/censys-sdk-python

🖥️ 新しい CLI ツール (cencli): censys/cencli

⚠️ 新しい CLI を使用する予定がある場合は、先にこのパッケージの CLI をアンインストールする必要があります。両方が censys コマンド名を使用するためです。

このライブラリの Censys ASM API は非推奨ではありません。引き続きサポートされます。

Censys API (censys.io) 向けの、使いやすく軽量な API ラッパーです。Python 3.9+ が現在サポートされています。このライブラリは Python 3.9 および 3.x (現在はバージョン 3.13) でテストされています。

特徴

はじめに

このライブラリは pip を使用してインストールできます。

pip install censys

pip を使用してアップグレードする場合。

pip install --upgrade censys

あるいは、uv を使用してライブラリをインストールすることもできます。

git clone https://github.com/censys/censys-python.git
cd censys-python/
uv install

必要に応じて、~/.bashrc、~/.zshrc などに次の行を追加することで、CLI のタブ補完を有効にできます。

オートコンプリートは search コマンドのフィールド名でサポートされていることに注意してください。

eval "$(register-python-argcomplete censys)"

検索資格情報を設定するには、censys config を実行するか、CENSYS_API_ID と CENSYS_API_SECRET の両方の環境変数を設定します。

$ censys config

Censys API ID: XXX
Censys API Secret: XXX
Do you want color output? [y/n]: y

Successfully authenticated for [email protected]

Censys ASM アカウントをお持ちの場合は、censys asm config を実行するか、CENSYS_ASM_API_KEY 環境変数を設定することで、ASM 資格情報を設定できます。

$ censys asm config

Censys ASM API Key: XXX
Do you want color output? [y/n]: y

Successfully authenticated

例

examples/ ディレクトリにある例は、始めるのに最適な場所です。使用法ドキュメントにも、さらに多くの例があります。

ドキュメント

リソース

貢献

すべての貢献 (どんなに小さくても) を常に歓迎します。Censys Python への貢献を参照してください。

開発

このプロジェクトは依存関係管理に uv を使用しています。最新バージョンをインストールしていることを確認してください。

git clone [email protected]:censys/censys-python.git
cd censys-python/
uv install

テスト

# テストを実行
uv run pytest
# カバレッジレポート付き
uv run pytest --cov-report html

ライセンス

このソフトウェアは Apache License, Version 2.0 の下でライセンスされています。

censys-python v2.3.0

カテゴリ