D4
/
BGP-Ranking
mirror of https://github.com/D4-project/BGP-Ranking
2
0
Fork 0
Code Issues Releases Wiki Activity

chg: Add documentation for Python client

pull/12/head
Raphaël Vinot 2019-06-16 17:03:22 +02:00
parent cc7c953493
commit dd39ad2f29
1 changed files with 17 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -20,6 +20,22 @@ BGP Ranking is free software licensed under the GNU Affero General Public Licens
BGP Ranking is a software to rank AS numbers based on their malicious activities. BGP Ranking is a software to rank AS numbers based on their malicious activities.
# Python client
```bash
$ pip install git+https://github.com/D4-project/BGP-Ranking.git/#egg=pybgpranking\&subdirectory=client
$ bgpranking --help
usage: bgpranking [-h] [--url URL] (--asn ASN | --ip IP)
Run a query against BGP Ranking
optional arguments:
-h, --help show this help message and exit
--url URL URL of the instance.
--asn ASN ASN to lookup
--ip IP IP to lookup
```
## History ## History
The first version of BGP Ranking was done in 2010 by [Raphael Vinot](https://github.com/Rafiot) with the support of [Alexandre Dulaunoy](https://github.com/adulau/). The first version of BGP Ranking was done in 2010 by [Raphael Vinot](https://github.com/Rafiot) with the support of [Alexandre Dulaunoy](https://github.com/adulau/).
@ -36,7 +52,7 @@ A Python library and client software is [available](https://github.com/D4-projec
# CURL Example # CURL Example
## Get the ASN from an IP or a prefix ## Get the ASN from an IP or a prefix
```bash ```bash
curl https://bgpranking-ng.circl.lu/ipasn_history/?ip=143.255.153.0/24 curl https://bgpranking-ng.circl.lu/ipasn_history/?ip=143.255.153.0/24
``` ```