.. Censys Python documentation master file, created by
   sphinx-quickstart on Fri Sep 11 10:57:18 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Censys Python's documentation!
=========================================

Release v\ |version|. (:ref:`quick-start:Quick Start`)

.. image:: https://img.shields.io/pypi/v/censys?color=orange&logo=pypi&logoColor=orange
   :target: https://pypi.org/project/censys/

.. image:: https://img.shields.io/badge/python-3.8%2B-blue?logo=python
   :target: https://www.python.org/downloads/

.. image:: https://img.shields.io/github/license/censys/censys-python?logo=apache
   :target: https://github.com/censys/censys-python/blob/main/LICENSE

**Censys Python** is an easy-to-use and lightweight API wrapper for Censys APIs.

-------------------

The User Guide
--------------

.. toctree::
   :maxdepth: 1

   quick-start
   usage-cli
   usage-v2
   usage-v1
   usage-asm
   advanced-usage

The API Documentation
---------------------

.. toctree::
   :maxdepth: 1

   censys
   cli

The Contributor Guide
---------------------

.. toctree::
   :maxdepth: 1

   contributing
   development
   testing
   GitHub Repo <https://github.com/censys/censys-python>
