Skip to content

censys/censys-python

main
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

Bumps [flake8-docstrings](https://github.com/pycqa/flake8-docstrings) from 1.6.0 to 1.7.0.
- [Release notes](https://github.com/pycqa/flake8-docstrings/releases)
- [Changelog](https://github.com/PyCQA/flake8-docstrings/blob/main/HISTORY.rst)
- [Commits](PyCQA/flake8-docstrings@1.6.0...1.7.0)

---
updated-dependencies:
- dependency-name: flake8-docstrings
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
eebacdd

Git stats

Files

Permalink
Failed to load latest commit information.

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.7+ 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
Do you want color output? [y/n]: y

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
Do you want color output? [y/n]: y

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
poetry run pytest
# With coverage report
poetry run pytest --cov-report html

License

This software is licensed under Apache License, Version 2.0

  • Copyright (C) 2022 Censys, Inc.