chg: Add documentation for Python client
parent
cc7c953493
commit
dd39ad2f29
16
README.md
16
README.md
|
@ -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/).
|
||||||
|
|
Loading…
Reference in New Issue