Biblioteca Python Censys

[!WARNING] AVISO DE DESCONTINUAÇÃO: As APIs Censys Search v1 e v2 serão descontinuadas em breve. Por favor, migre para a nova Censys Platform.

📖 Nova Documentação da API: https://docs.censys.com/reference/get-started

📦 Novo SDK Python: censys/censys-sdk-python

🖥️ Nova Ferramenta CLI (cencli): censys/cencli

⚠️ Se você planeja usar a nova CLI, precisará desinstalar a CLI deste pacote primeiro, pois ambas usam o nome de comando censys

As APIs Censys ASM nesta biblioteca NÃO estão descontinuadas e continuarão sendo suportadas.

Um wrapper de API leve e fácil de usar para as APIs Censys (censys.io). Python 3.9+ é atualmente suportado. Esta biblioteca foi testada em Python 3.9 e 3.x (atualmente versão 3.13).

Recursos

Começando

A biblioteca pode ser instalada usando pip.

pip install censys

Para atualizar usando pip.

pip install --upgrade censys

Alternativamente, você pode instalar a biblioteca usando uv.

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

Opcionalmente, você pode habilitar a conclusão por tabulação para a CLI adicionando esta linha ao seu ~/.bashrc, ~/.zshrc ou equivalente.

Observe que o autocompletar é suportado para nomes de campos no comando search.

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

Para configurar suas credenciais de pesquisa, execute censys config ou defina as variáveis de ambiente CENSYS_API_ID e 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]

Se você tiver uma conta Censys ASM, pode configurar suas credenciais ASM executando censys asm config ou definindo a variável de ambiente CENSYS_ASM_API_KEY.

$ censys asm config

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

Successfully authenticated

Exemplos

Os exemplos localizados no diretório examples/ são um ótimo ponto de partida. Você também pode encontrar mais exemplos na documentação de uso.

Documentação

Recursos

Contribuindo

Todas as contribuições (não importa quão pequenas) são sempre bem-vindas. Consulte Contribuindo para Censys Python

Desenvolvimento

Este projeto usa uv para gerenciamento de dependências. Certifique-se de ter instalado a versão mais recente.

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

Testes

# Executar testes
uv run pytest
# Com relatório de cobertura
uv run pytest --cov-report html

Licença

Este software é licenciado sob Apache License, Version 2.0

Ler mais

censys-python v2.3.0

Categorias