censys-python

(β˜… 468)

An easy-to-use and lightweight API wrapper for Censys APIs.

  • .coveragerc
  • .flake8
  • .gitignore
  • .pre-commit-config.yaml
  • .readthedocs.yml
  • conftest.py
  • LICENSE
  • poetry.lock
  • pyproject.toml
  • pytest.ini
  • README.md

# Installation Guide

1. Get the code
git clone https://github.com/censys/censys-python

Downloads the entire project code from GitHub to your computer.

cd censys-python

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Python 3 Python is required to use pip.
pip install censys

Installs the package published on PyPI directly β€” no need to clone the source.

pip install --upgrade censys

Installs the package published on PyPI directly β€” no need to clone the source.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install censys

Installs the package published on PyPI directly β€” no need to clone the source.

pip install --upgrade censys

Installs the package published on PyPI directly β€” no need to clone the source.

poetry install

Installs the libraries listed in pyproject.toml.

poetry run pytest

Type this command into your terminal and run it.

poetry run pytest --cov-report html

Type this command into your terminal and run it.

βœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation