censys

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

Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
✓
Committers with academic emails
1 of 29 committers (3.4%) from academic institutions
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (13.6%) to scientific vocabulary

Keywords

api attack-surface-management censys hacktoberfest pypi python python3 search

Keywords from Contributors

research interactive port-scanner internet-scanning internet-measurement dns serializer packaging network-simulation shellcodes

Last synced: 6 months ago · JSON representation

Repository

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

Basic Info

Host: GitHub
Owner: censys
License: apache-2.0
Language: Python
Default Branch: main
Homepage: https://censys-python.rtfd.io/
Size: 2.4 MB

Statistics

Stars: 441
Watchers: 18
Forks: 96
Open Issues: 4
Releases: 46

Topics

api attack-surface-management censys hacktoberfest pypi python python3 search

Created over 10 years ago · Last pushed 7 months ago

Metadata Files

Readme Contributing License Code of conduct

README.md

Censys Python Library

[!WARNING] DEPRECATION NOTICE: The Censys Search v1 and v2 APIs will be deprecated soon. Please migrate to the new Censys Platform API.

📖 New API Documentation: https://docs.censys.com/reference/get-started#/

📦 New Python SDK: Install with pip install censys-platform - https://pypi.org/project/censys-platform/

The Censys ASM APIs in this library are NOT deprecated and will continue to be supported.

An easy-to-use and lightweight API wrapper for Censys APIs (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 for resources.

[!IMPORTANT] This library does not support the new Censys Platform, however a new set of SDKs that do support the platform are coming soon. Please refer to the platform API refrence docs in the mean time.

Features

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/ directory are a great place to start. You can also find more examples in the usage documentation.

Documentation

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.

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

Owner

Name: Censys
Login: censys
Kind: organization
Email: support@censys.com
Location: Ann Arbor

Website: https://www.censys.com
Twitter: censysio
Repositories: 23
Profile: https://github.com/censys

Censys is a platform that helps information security practitioners discover, monitor, and analyze devices that are accessible from the Internet.

GitHub Events

Total

Create event: 34
Issues event: 5
Release event: 4
Watch event: 42
Delete event: 26
Member event: 1
Issue comment event: 51
Push event: 40
Pull request review comment event: 3
Pull request review event: 19
Pull request event: 71
Fork event: 8

Last Year

Create event: 34
Issues event: 5
Release event: 4
Watch event: 42
Delete event: 26
Member event: 1
Issue comment event: 51
Push event: 40
Pull request review comment event: 3
Pull request review event: 19
Pull request event: 71
Fork event: 8

Committers

Last synced: 9 months ago

All Time

Total Commits: 930
Total Committers: 29
Avg Commits per committer: 32.069
Development Distribution Score (DDS): 0.456

Past Year

Commits: 34
Committers: 7
Avg Commits per committer: 4.857
Development Distribution Score (DDS): 0.588

Top Committers

Name	Email	Commits
Aidan Holland	a**n@c**o	506
dependabot[bot]	4****]	292
Zakir Durumeric	z**d@g**m	43
Grace Murphy	g**e@c**o	14
Edwin Zishiri	e**i@c**o	12
Michael Bremerkamp	m**m@m**n	8
Grace Murphy	g**m@c**o	8
David Adrian	d**n@g**m	7
Fabian Weisshaar	e**o@n**o	7
Thomas Harning Jr	t**s@c**o	6
Bob Dickinson	b**n@g**m	4
Ryan Kagin	r**n@f**m	3
Benjamin Wireman	b**n@c**o	2
Andrew Alexander	a****r	2
Malware Utkonos	u**s@m**y	2
jxdv	v**j@p**m	1
jose nazario	4****s	1
Tanner Embry	h**o@t**m	1
Scott Colby	s**3@g**m	1
Ricky Diaz Gomez	r**a@u**u	1
Olivier Bilodeau	o**r@b**g	1
Matt Clement	4****t	1
Letu Ren	f**x@g**m	1
Jacek Wielemborek	2****h	1
Michael Bremerkamp	m**m@c**o	1
Elliot Cubit	e**t@c**o	1
Chaz Lever	c****r	1
Brahm Lower	b**m@c**o	1
Brahm Lower	b**r@g**m	1

Committer Domains (Top 20 + Academic)

censys.io: 9 bottomlesspit.org: 1 umich.edu: 1 tannerembry.com: 1 malwarolo.gy: 1 fb.com: 1 nerdpol.io: 1 michaels-mbp.lan: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 23
Total pull requests: 301
Average time to close issues: 2 months
Average time to close pull requests: 13 days
Total issue authors: 17
Total pull request authors: 14
Average comments per issue: 2.13
Average comments per pull request: 0.69
Merged pull requests: 151
Bot issues: 0
Bot pull requests: 253

Past Year

Issues: 3
Pull requests: 67
Average time to close issues: about 1 month
Average time to close pull requests: 21 days
Issue authors: 3
Pull request authors: 10
Average comments per issue: 0.67
Average comments per pull request: 1.21
Merged pull requests: 18
Bot issues: 0
Bot pull requests: 44

View more stats

Top Authors

Issue Authors

lolminerxmrig (7)
thehappydinoa (2)
MaxGroot (1)
Toshimichi0915 (1)
cloudjunky (1)
Lem (1)
papichamonz (1)
martinmladenov (1)
rlregist (1)
nkh8212 (1)
boogiekim (1)
kylet-rf (1)
da7om85 (1)
blackpoplar (1)
stlazs (1)

Pull Request Authors

dependabot[bot] (293)
thehappydinoa (25)
grace-murphy (8)
harningt (4)
devangb3 (4)
andrewalexander (3)
BobDickinson (2)
jxdv (2)
rickydia (2)
gabrielsaldana (2)
rkagin (2)
brahmlower (2)
bplcensys (2)
btschwartz12 (1)

Top Labels

Issue Labels

type: bug (11) type: question (7) type: feature request (5) type: documentation (1) good first issue (1) feat: cli (1) stale (1)

Pull Request Labels

type: dependencies (294) stale (17) type: enhancement (6) feat: cli (4) feat: api (2) github_actions (2)

Packages

Total packages: 2
Total downloads:
- homebrew 82 last-month
- pypi 83,388 last-month
Total docker downloads: 3,740,746

Total dependent packages: 3
(may contain duplicates)
Total dependent repositories: 309
(may contain duplicates)
Total versions: 80
Total maintainers: 4

pypi.org: censys

An easy-to-use and lightweight API wrapper for Censys APIs (censys.io).

Documentation: https://censys-python.rtfd.io
License: Apache-2.0
Latest release: 2.2.18
published 7 months ago

Versions: 58
Dependent Packages: 3
Dependent Repositories: 309
Downloads: 83,388 Last month
Docker Downloads: 3,740,746

Rankings

Docker downloads count: 0.7%

Downloads: 0.8%

Dependent repos count: 0.8%

Average: 2.4%

Stargazers count: 3.4%

Forks count: 4.1%

Dependent packages count: 4.8%

Maintainers (4)

thehappydinoa censys.io zakir jbastress

Last synced: 6 months ago

formulae.brew.sh: censys

Command-line interface for the Censys APIs (censys.io)

Homepage: https://github.com/censys/censys-python
License: Apache-2.0
Latest release: 2.2.18
published 6 months ago

Versions: 22
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 82 Last month

Rankings

Dependent packages count: 19.0%

Forks count: 19.8%

Stargazers count: 26.1%

Average: 38.8%

Dependent repos count: 50.7%

Downloads: 78.5%

Last synced: 6 months ago

Dependencies

docs/requirements.txt pypi

sphinx >=3.2.1
sphinx-copybutton ==0.5.0
sphinx-prompt ==1.5.0
sphinx-rtd-theme ==1.0.0
sphinx-tabs ==3.4.1
sphinxcontrib-autoprogram ==0.1.7

poetry.lock pypi

astor 0.8.1 develop
atomicwrites 1.4.1 develop
attrs 21.4.0 develop
black 22.6.0 develop
blacken-docs 1.12.1 develop
click 8.1.3 develop
colorama 0.4.5 develop
coverage 6.4.2 develop
darglint 1.8.1 develop
flake8 4.0.1 develop
flake8-black 0.3.3 develop
flake8-comprehensions 3.10.0 develop
flake8-docstrings 1.6.0 develop
flake8-isort 4.1.2.post0 develop
flake8-plugin-utils 1.3.2 develop
flake8-pytest-style 1.6.0 develop
flake8-simplify 0.19.3 develop
iniconfig 1.1.1 develop
isort 5.10.1 develop
mccabe 0.6.1 develop
mypy 0.971 develop
mypy-extensions 0.4.3 develop
packaging 21.3 develop
parameterized 0.8.1 develop
pathspec 0.9.0 develop
pep8-naming 0.13.1 develop
platformdirs 2.5.2 develop
pluggy 1.0.0 develop
py 1.11.0 develop
pycodestyle 2.8.0 develop
pydocstyle 6.1.1 develop
pyflakes 2.4.0 develop
pyparsing 3.0.9 develop
pytest 7.1.2 develop
pytest-cov 3.0.0 develop
pytest-mock 3.8.2 develop
pyupgrade 2.37.3 develop
responses 0.21.0 develop
snowballstemmer 2.2.0 develop
tokenize-rt 4.2.1 develop
tomli 2.0.1 develop
typed-ast 1.5.4 develop
types-requests 2.28.7 develop
types-urllib3 1.26.17 develop
backoff 2.1.2
certifi 2022.6.15
charset-normalizer 2.1.0
commonmark 0.9.1
idna 3.3
importlib-metadata 4.2.0
pygments 2.12.0
requests 2.28.1
rich 12.5.1
typing-extensions 4.3.0
urllib3 1.26.11
zipp 3.8.1

pyproject.toml pypi

black ^22.6.0 develop
blacken-docs ^1.12.1 develop
darglint ^1.8.1 develop
flake8 ^4.0.1 develop
flake8-black ^0.3.3 develop
flake8-comprehensions ^3.10.0 develop
flake8-docstrings ^1.6.0 develop
flake8-isort ^4.1.2 develop
flake8-pytest-style ^1.6.0 develop
flake8-simplify ^0.19.3 develop
isort ^5.10.1 develop
mypy ^0.971 develop
parameterized ^0.8.1 develop
pep8-naming ^0.13.1 develop
pytest ^7.1.2 develop
pytest-cov ^3.0.0 develop
pytest-mock ^3.8.2 develop
pyupgrade ^2.37.3 develop
responses ^0.21.0 develop
types-requests >=2.26.0 develop
backoff ^2.0.1
importlib-metadata *
python ^3.7
requests >=2.26.0
rich >=10.16.2

.github/workflows/pypi.yml actions

actions/cache v2 composite
actions/checkout v2 composite
actions/setup-python v2 composite

.github/workflows/python-ci.yml actions

actions/checkout v2 composite
actions/setup-python v2 composite

.github/workflows/stale.yml actions

actions/stale v3 composite