Skip to main content

An easy-to-use and lightweight API wrapper for Censys APIs (censys.io).

Project description

Censys Python Library

PyPI Python Version Read the Docs (version) GitHub Discussions PRs Welcome License

An easy-to-use and lightweight API wrapper for Censys APIs (censys.io). Python 3.6.2+ is currently supported.

Notice: The Censys Search v1 endpoints are deprecated as of Nov. 30, 2021. Please begin using v2 endpoints to query hosts and certificates and check out our support center for resources.

Features

Getting Started

The library can be installed using pip.

pip install censys

To upgraded using pip.

pip install --upgrade censys

To configure your search credentials run censys config or set both CENSYS_API_ID and CENSYS_API_SECRET environment variables.

$ censys config

Censys API ID: XXX
Censys API Secret: XXX

Successfully authenticated for your@email.com

To configure your ASM credentials run censys asm config or set the CENSYS_ASM_API_KEY environment variables.

$ censys asm config

Censys ASM API Key: XXX

Successfully authenticated

API Reference and User Guide available on Read the Docs

Read the Docs

Resources

Contributing

All contributions (no matter how small) are always welcome. See Contributing to Censys Python

Development

This project uses poetry for dependency management. Please ensure you have installed the latest version.

git clone git@github.com:censys/censys-python.git
cd censys-python/
poetry install

Testing

# Run tests
pytest
# With coverage report
pytest --cov-report html

License

This software is licensed under Apache License, Version 2.0

  • Copyright (C) 2022 Censys, Inc.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

censys-2.1.3.tar.gz (35.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

censys-2.1.3-py3-none-any.whl (55.5 kB view details)

Uploaded Python 3

File details

Details for the file censys-2.1.3.tar.gz.

File metadata

  • Download URL: censys-2.1.3.tar.gz
  • Upload date:
  • Size: 35.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.10.2 Linux/5.11.0-1028-azure

File hashes

Hashes for censys-2.1.3.tar.gz
Algorithm Hash digest
SHA256 50bc63625fc6db0bf94a5fab5280a9d4c48aed3b4eca43b86bdf9668bf3bc980
MD5 7e81248a56acda44062f0d0e30af06f8
BLAKE2b-256 75e34db8e47fd59fa163372494ddaa4bbf3a6fede27d0e03a7b2f165f02f0c79

See more details on using hashes here.

File details

Details for the file censys-2.1.3-py3-none-any.whl.

File metadata

  • Download URL: censys-2.1.3-py3-none-any.whl
  • Upload date:
  • Size: 55.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.10.2 Linux/5.11.0-1028-azure

File hashes

Hashes for censys-2.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 dc2b06f40ca7f5386ba8d361c484be6092c580c06f967a7f858e69fe6519fb50
MD5 06c2c669bc970acb3fc149e89d4437c6
BLAKE2b-256 d747205a13a9d0022c72c7b266f3961de9f1c88c8ac58341cce9a59a5d55c63d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page