python wrapper for abuseipdb API
Project description
Info
python wrapper for abuseipdb API -> https://docs.abuseipdb.com/#introduction
allows you to get info about specified IP address(es) abuse
aimed to local db usage, quick query and response
Install
stable version from pypi
pip install abuseipdb-wrapper
or newest version from github
pip install git+https://github.com/streanger/abuseipdb-wrapper.git
Example usage
init `AbuseIPDB` object
Init AbuseIPDB object using API KEY created on https://www.abuseipdb.com/. Optionally you can provide db_file for your local database. It is recommended becasue this project aims on storing data for further quick access without need of another requests.
from abuseipdb_wrapper import AbuseIPDB API_KEY = 'YOUR_API_KEY' # provide API KEY and local db filename abuse = AbuseIPDB(API_KEY=API_KEY, db_file='abuseipdb.json') abuse.colors_legend() # show colors legend
check list of IP’s
Specify list of IP’s to check and apply them using add_ip_list method. Next step run check method and wait.
ips = ['1.2.3.4', '5.6.7.8', '9.10.11.12', '13.14.15.16'] abuse.add_ip_list(ips) abuse.check()
show local db
To display collected information use show_db call. Data table should be displayed on terminal. Alternatively call print on your AbuseIPDB object. Before showing db you can specifiy columns to be displayed. Do it using apply_columns_order method.
abuse.apply_columns_order( ['ipAddress', 'abuseConfidenceScore', 'totalReports', 'countryCode', 'domain', 'isp'] ) print(abuse) abuse.show_db(matched_only=False, table_view=True)
db viewer
For interactive viewing of IP’s and checking them as well use viewer method. It let you to provide list of IP’s or single one. Use help for more information.
abuse.viewer()
export db to csv file
abuse.export_csv('out.csv', matched_only=False)
export db to styled html file
abuse.export_html_styled('out.html', matched_only=False)
export db to styled xlsx file
abuse.export_xlsx_styled('out.xlsx', matched_only=False)
convert to dataframe object
df = abuse.get_df(matched_only=False)
json columns
abuseConfidenceScore
countryCode
date
domain
hostnames
ipAddress
ipVersion
isPublic
isWhitelisted
isp
lastReportedAt
numDistinctUsers
totalReports
url
usageType
Screenshots
colors legend
interactive viewer help
checking IPs
showing IPs in vertical mode
showing IPs in table mode
Todo/to think of
black background for better view in powershell
wrap text in table columns (not only cut off with dots)
allow for justify/center table
allow for db sorting (specified by user)
implement more methods accessible from interactive view
IP ranges for viewer -> 1.2.3.0/24
make console script
think of more info than ‘data’ section in api response: reports -> comments, categories
check subnet 1.2.3.4/24 -> https://www.abuseipdb.com/check-block/1.2.3.4/24
allow passing arguments (colors) for style_df function from abuse class level
Implemented
html output (from rich table or from pandas df)
wrap text in table cells - made using rich table
return dataframe object
date of last check
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for abuseipdb_wrapper-0.1.5-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 076f66ee52aeb479f934be53d89f7d3aae8bf47acb62ea36e67139f4daba11e0 |
|
MD5 | c888ff22fa7365710f75c03d8b7572af |
|
BLAKE2b-256 | 571a44c510f375d2b6cfc07ef5a74ea8bb7252993a344b975730403f5274a673 |