# Censys Python Library
[](https://pypi.org/project/censys/)
[](https://www.python.org/downloads/)
[](https://censys-python.readthedocs.io/en/stable/?badge=stable)
[](https://github.com/censys/censys-python/discussions)
[](http://makeapullrequest.com)
[](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.8+ is currently supported. This library has been tested on Python 3.8 and 3.x (Currently version 3.10).
> **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-v2.html#bulk-view)
- [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)
<!-- markdownlint-disable MD033 -->
<a href="https://asciinema.org/a/500416" target="_blank"><img src="https://asciinema.org/a/500416.svg" width="600"/></a>
<!-- markdownlint-enable MD033 -->
## Getting Started
The library can be installed using `pip`.
```sh
pip install censys
```
To upgraded using `pip`.
```sh
pip install --upgrade censys
```
Alternatively, you can install the library using `poetry`.
```sh
git clone https://github.com/censys/censys-python.git
cd censys-python/
poetry install
```
Optionally, you can enable tab completion for the CLI by adding this line to your `~/.bashrc`, `~/.zshrc`, or equivalent.
> Please note that autocomplete is supported for field names in the `search` command.
```sh
eval "$(register-python-argcomplete 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
```
If you have a Censys ASM account, you can configure your ASM credentials by running `censys asm config` or set both `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
```
## Examples
The examples located in the [`examples/`](examples/) directory are a great place to start. You can also find more examples in the [usage documentation](https://censys-python.readthedocs.io/en/stable/usage-v2.html).
## [Documentation](https://censys-python.readthedocs.io/)
[](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) 2024 Censys, Inc.
Raw data
{
"_id": null,
"home_page": null,
"name": "censys",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "censys, api, search, attack surface management",
"author": "Censys, Inc.",
"author_email": "support@censys.io",
"download_url": "https://files.pythonhosted.org/packages/08/69/76c19cff1cac71420eb731300f39bbba90308a23a8bca9bd6a6d5bafdeff/censys-2.2.16.tar.gz",
"platform": null,
"description": "# Censys Python Library\n\n[](https://pypi.org/project/censys/)\n[](https://www.python.org/downloads/)\n[](https://censys-python.readthedocs.io/en/stable/?badge=stable)\n[](https://github.com/censys/censys-python/discussions)\n[](http://makeapullrequest.com)\n[](https://github.com/censys/censys-python/blob/main/LICENSE)\n\nAn easy-to-use and lightweight API wrapper for Censys APIs ([censys.io](https://censys.io/)). Python 3.8+ is currently supported. This library has been tested on Python 3.8 and 3.x (Currently version 3.10).\n\n> **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.\n\n## Features\n\n- [Search Censys data](https://censys-python.readthedocs.io/en/stable/usage-v2.html)\n- [Bulk Certificate lookups](https://censys-python.readthedocs.io/en/stable/usage-v2.html#bulk-view)\n- [Download Bulk Data](https://censys-python.readthedocs.io/en/stable/usage-v1.html#data)\n- [Manage assets, events, and seeds in Censys ASM](https://censys-python.readthedocs.io/en/stable/usage-asm.html)\n- [Command-line interface](https://censys-python.readthedocs.io/en/stable/cli.html)\n\n<!-- markdownlint-disable MD033 -->\n\n<a href=\"https://asciinema.org/a/500416\" target=\"_blank\"><img src=\"https://asciinema.org/a/500416.svg\" width=\"600\"/></a>\n\n<!-- markdownlint-enable MD033 -->\n\n## Getting Started\n\nThe library can be installed using `pip`.\n\n```sh\npip install censys\n```\n\nTo upgraded using `pip`.\n\n```sh\npip install --upgrade censys\n```\n\nAlternatively, you can install the library using `poetry`.\n\n```sh\ngit clone https://github.com/censys/censys-python.git\ncd censys-python/\npoetry install\n```\n\nOptionally, you can enable tab completion for the CLI by adding this line to your `~/.bashrc`, `~/.zshrc`, or equivalent.\n\n> Please note that autocomplete is supported for field names in the `search` command.\n\n```sh\neval \"$(register-python-argcomplete censys)\"\n```\n\nTo configure your search credentials run `censys config` or set both `CENSYS_API_ID` and `CENSYS_API_SECRET` environment variables.\n\n```sh\n$ censys config\n\nCensys API ID: XXX\nCensys API Secret: XXX\nDo you want color output? [y/n]: y\n\nSuccessfully authenticated for your@email.com\n```\n\nIf you have a Censys ASM account, you can configure your ASM credentials by running `censys asm config` or set both `CENSYS_ASM_API_KEY` environment variables.\n\n```sh\n$ censys asm config\n\nCensys ASM API Key: XXX\nDo you want color output? [y/n]: y\n\nSuccessfully authenticated\n```\n\n## Examples\n\nThe examples located in the [`examples/`](examples/) directory are a great place to start. You can also find more examples in the [usage documentation](https://censys-python.readthedocs.io/en/stable/usage-v2.html).\n\n## [Documentation](https://censys-python.readthedocs.io/)\n\n[](https://censys-python.readthedocs.io/)\n\n## Resources\n\n- [Source](https://github.com/censys/censys-python)\n- [Issue Tracker](https://github.com/censys/censys-python/issues)\n- [Changelog](https://github.com/censys/censys-python/releases)\n- [Documentation](https://censys-python.rtfd.io)\n- [Discussions](https://github.com/censys/censys-python/discussions)\n- [Censys Homepage](https://censys.io/)\n- [Censys Search](https://search.censys.io/)\n\n## Contributing\n\nAll contributions (no matter how small) are always welcome. See [Contributing to Censys Python](.github/CONTRIBUTING.md)\n\n## Development\n\nThis project uses [poetry](https://python-poetry.org/) for dependency management. Please ensure you have [installed the latest version](https://python-poetry.org/docs/#installation).\n\n```sh\ngit clone git@github.com:censys/censys-python.git\ncd censys-python/\npoetry install\n```\n\n## Testing\n\n```sh\n# Run tests\npoetry run pytest\n# With coverage report\npoetry run pytest --cov-report html\n```\n\n## License\n\nThis software is licensed under [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)\n\n- Copyright (C) 2024 Censys, Inc.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "An easy-to-use and lightweight API wrapper for Censys APIs (censys.io).",
"version": "2.2.16",
"project_urls": {
"Censys Homepage": "https://censys.io/",
"Censys Search": "https://search.censys.io/",
"Changelog": "https://github.com/censys/censys-python/releases",
"Discussions": "https://github.com/censys/censys-python/discussions",
"Documentation": "https://censys-python.rtfd.io",
"Source": "https://github.com/censys/censys-python",
"Tracker": "https://github.com/censys/censys-python/issues"
},
"split_keywords": [
"censys",
" api",
" search",
" attack surface management"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "490db0ef23b5f4104f64fee853176292113044a85c7a56a85c55ad398cb52007",
"md5": "d0912cacf3626af0472ddd8e4e7c2a85",
"sha256": "54906deca331b4a5412be79543be21b5ffae800313de468a001ec7ea27f1b81c"
},
"downloads": -1,
"filename": "censys-2.2.16-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d0912cacf3626af0472ddd8e4e7c2a85",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 79624,
"upload_time": "2024-10-21T15:36:29",
"upload_time_iso_8601": "2024-10-21T15:36:29.229344Z",
"url": "https://files.pythonhosted.org/packages/49/0d/b0ef23b5f4104f64fee853176292113044a85c7a56a85c55ad398cb52007/censys-2.2.16-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "086976c19cff1cac71420eb731300f39bbba90308a23a8bca9bd6a6d5bafdeff",
"md5": "5fdc3eeb8a1d34de6740c892c819c053",
"sha256": "c70680ee84630fba20c3d14f1ed0d9c2a5a2d54009d0821fbaa9fed8119c4ee3"
},
"downloads": -1,
"filename": "censys-2.2.16.tar.gz",
"has_sig": false,
"md5_digest": "5fdc3eeb8a1d34de6740c892c819c053",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 62216,
"upload_time": "2024-10-21T15:36:30",
"upload_time_iso_8601": "2024-10-21T15:36:30.530216Z",
"url": "https://files.pythonhosted.org/packages/08/69/76c19cff1cac71420eb731300f39bbba90308a23a8bca9bd6a6d5bafdeff/censys-2.2.16.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-21 15:36:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "censys",
"github_project": "censys-python",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "censys"
}
JSON
