Bibliothèque Python Censys

[!WARNING] AVIS DE DÉPRÉCIATION : Les API Censys Search v1 et v2 seront bientôt dépréciées. Veuillez migrer vers la nouvelle plateforme Censys.

📖 Nouvelle documentation API : https://docs.censys.com/reference/get-started

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

🖥️ Nouvel outil CLI (cencli) : censys/cencli

⚠️ Si vous prévoyez d'utiliser le nouveau CLI, vous devrez d'abord désinstaller le CLI de ce paquet car les deux utilisent le nom de commande censys

Les API Censys ASM de cette bibliothèque ne sont PAS dépréciées et continueront d'être prises en charge.

Un wrapper API léger et facile à utiliser pour les API Censys (censys.io). Python 3.9+ est actuellement pris en charge. Cette bibliothèque a été testée sur Python 3.9 et 3.x (actuellement version 3.13).

Fonctionnalités

Pour commencer

La bibliothèque peut être installée à l'aide de pip.

pip install censys

Pour la mettre à niveau à l'aide de pip.

pip install --upgrade censys

Vous pouvez également installer la bibliothèque à l'aide de uv.

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

Vous pouvez éventuellement activer la complétion par tabulation pour le CLI en ajoutant cette ligne à votre ~/.bashrc, ~/.zshrc ou équivalent.

Veuillez noter que la complétion automatique est prise en charge pour les noms de champs dans la commande search.

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

Pour configurer vos identifiants de recherche, exécutez censys config ou définissez les variables d'environnement CENSYS_API_ID et 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]

Si vous disposez d'un compte Censys ASM, vous pouvez configurer vos identifiants ASM en exécutant censys asm config ou en définissant la variable d'environnement CENSYS_ASM_API_KEY.

$ censys asm config

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

Successfully authenticated

Exemples

Les exemples situés dans le répertoire examples/ sont un excellent point de départ. Vous pouvez également trouver plus d'exemples dans la documentation d'utilisation.

Documentation

Ressources

Contribuer

Toutes les contributions (quelle que soit leur taille) sont toujours les bienvenues. Voir Contribuer à Censys Python

Développement

Ce projet utilise uv pour la gestion des dépendances. Veuillez vous assurer d'avoir installé la dernière version.

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

Tests

# Exécuter les tests
uv run pytest
# Avec rapport de couverture
uv run pytest --cov-report html

Licence

Ce logiciel est sous licence Apache License, Version 2.0

Lire plus

censys-python v2.3.0

Catégories