Metadata-Version: 1.2
Name: censys
Version: 2.1.9
Summary: An easy-to-use and lightweight API wrapper for Censys APIs (censys.io).
Home-page: None
Author: Censys, Inc.
Author-email: support@censys.io
Maintainer: None
Maintainer-email: None
License: UNKNOWN
Description: # Censys Python Library
        
        [![PyPI](https://img.shields.io/pypi/v/censys?color=orange&logo=pypi&logoColor=orange)](https://pypi.org/project/censys/)
        [![Python Version](https://img.shields.io/badge/python-3.7%2B-blue?logo=python)](https://www.python.org/downloads/)
        [![Read the Docs (version)](https://img.shields.io/readthedocs/censys-python/latest?logo=read%20the%20docs)](https://censys-python.readthedocs.io/en/stable/?badge=stable)
        [![GitHub Discussions](https://img.shields.io/badge/GitHub-Discussions-brightgreen?logo=github)](https://github.com/censys/censys-python/discussions)
        [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-organge.svg?logo=git&logoColor=organge)](http://makeapullrequest.com)
        [![License](https://img.shields.io/github/license/censys/censys-python?logo=apache)](https://github.com/censys/censys-python/blob/main/LICENSE)
        
        An easy-to-use and lightweight API wrapper for Censys APIs ([censys.io](https://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](https://support.censys.io/hc/en-us/sections/360013076551-Censys-Search-2-0) for resources.
        
        ## Features
        
        - [Search Censys data](https://censys-python.readthedocs.io/en/stable/usage-v2.html)
        - [Bulk Certificate lookups](https://censys-python.readthedocs.io/en/stable/usage-v1.html#bulk)
        - [Download Bulk Data](https://censys-python.readthedocs.io/en/stable/usage-v1.html#data)
        - [Manage assets, events, and seeds in Censys ASM](https://censys-python.readthedocs.io/en/stable/usage-asm.html)
        - [Command-line interface](https://censys-python.readthedocs.io/en/stable/cli.html)
        
        <a href="https://asciinema.org/a/500416" target="_blank"><img src="https://asciinema.org/a/500416.svg" width="600"/></a>
        
        ## Getting Started
        
        The library can be installed using `pip`.
        
        ```sh
        pip install censys
        ```
        
        To upgraded using `pip`.
        
        ```sh
        pip install --upgrade censys
        ```
        
        To configure your search credentials run `censys config` or set both `CENSYS_API_ID` and `CENSYS_API_SECRET` environment variables.
        
        ```sh
        $ 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.
        
        ```sh
        $ 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](https://censys-python.readthedocs.io/)
        
        [![Read the Docs](https://raw.githubusercontent.com/censys/censys-python/main/docs/_static/readthedocs.png)](https://censys-python.readthedocs.io/)
        
        ## Resources
        
        - [Source](https://github.com/censys/censys-python)
        - [Issue Tracker](https://github.com/censys/censys-python/issues)
        - [Changelog](https://github.com/censys/censys-python/releases)
        - [Documentation](https://censys-python.rtfd.io)
        - [Discussions](https://github.com/censys/censys-python/discussions)
        - [Censys Homepage](https://censys.io/)
        - [Censys Search](https://search.censys.io/)
        
        ## Contributing
        
        All contributions (no matter how small) are always welcome. See [Contributing to Censys Python](.github/CONTRIBUTING.md)
        
        ## Development
        
        This project uses [poetry](https://python-poetry.org/) for dependency management. Please ensure you have [installed the latest version](https://python-poetry.org/docs/#installation).
        
        ```sh
        git clone git@github.com:censys/censys-python.git
        cd censys-python/
        poetry install
        ```
        
        ## Testing
        
        ```sh
        # 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](http://www.apache.org/licenses/LICENSE-2.0)
        
        - Copyright (C) 2022 Censys, Inc.
        
Platform: UNKNOWN
Requires-Python: >=3.7,<4.0
