Библиотека Censys для Python

[!WARNING] УВЕДОМЛЕНИЕ ОБ УСТАРЕВАНИИ: API Censys Search версий v1 и v2 скоро будут объявлены устаревшими. Пожалуйста, переходите на новую платформу Censys.

📖 Новая документация API: https://docs.censys.com/reference/get-started

📦 Новый Python SDK: censys/censys-sdk-python

🖥️ Новый CLI-инструмент (cencli): censys/cencli

⚠️ Если вы планируете использовать новый CLI, вам сначала потребуется удалить CLI из этого пакета, так как оба используют имя команды censys

API Censys ASM в этой библиотеке НЕ являются устаревшими и будут продолжать поддерживаться.

Простой в использовании и легковесный обёрточный модуль для API Censys (censys.io). Поддерживается 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

При желании вы можете включить автодополнение по клавише Tab для CLI, добавив эту строку в ваш ~/.bashrc, ~/.zshrc или аналогичный файл.

Обратите внимание, что автодополнение поддерживается для имён полей в команде 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, вы можете настроить учётные данные ASM, выполнив censys asm config или задав переменную окружения CENSYS_ASM_API_KEY.

$ 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

Популярное