peeringdb-py

A PeeringDB 2.0 API wrapper client Python library. Making use of the new REST API.

Installation

To install peeringdb-py, simply:

$ sudo pip install peeringdb

Getting started

>>> from peeringdb.PeeringDB import PeeringDB
>>> pdb = PeeringDB()
>>> print pdb.asn(2906)

Find common IX locations:

>>> from peeringdb.PeeringDB import PeeringDB
>>> pdb = PeeringDB()
>>> print pdb.matching_ixlan([2906, 5089])

Caching

This library can optionally use Redis to improve the performance of your application and also reduce the load on the PeeringDB API.

By default the library will connect to a Redis instance running on localhost:6379, API responses are cached for 15 minutes, this can be easily disabled:

>>> from peeringdb.PeeringDB import PeeringDB
>>> pdb = PeeringDB(cache=False)

A different host and port specified:

>>> from peeringdb.PeeringDB import PeeringDB
>>> pdb = PeeringDB(cache_host=mycache.bigisp.org, cache_port=6800)

Cache TTL increased to 1 hour:

>>> from peeringdb.PeeringDB import PeeringDB
>>> pdb = PeeringDB(cache_ttl=3600)

Running unit tests

$ cd peeringdb-py
peeringdb-py $ python -m unittest discover

Contributing

Fork the repo on GitHub
Commit changes to a branch in your fork
Pull request "upstream" with your changes
Merge changes in to "upstream" repo

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

plajjan / peeringdb-py