The iptools package is a collection of utilities for dealing with IP addresses.
A few useful functions and objects for manipulating IPv4 and IPv6 addresses in
python. The project was inspired by a desire to be able to use CIDR address
notation to designate
INTERNAL_IPS in a Django project's settings file.
Using with Django
The IpRangeList object can be used in a Django settings file to allow CIDR
(start, end) ranges to be used in the
There are many internal and add-on components for Django that use the INTERNAL_IPS configuration setting to alter application behavior or make debugging easier. When you are developing and testing an application by yourself it's easy to add the ip address that your web browser will be coming from to this list. When you are developing in a group or testing from many ips it can become cumbersome to add more and more ip addresses to the setting individually.
iptools.IpRangeList object can help by replacing the standard tuple of
addresses recommended by the Django docs with an intelligent object that
responds to the membership test operator in. This object can be configured
with dotted quad IP addresses like the default INTERNAL_IPS tuple (eg.
'127.0.0.1'), CIDR block notation (eg. '127/8', '192.168/16') for entire
network blocks, and/or (start, end) tuples describing an arbitrary range of IP
Django's internal checks against the INTERNAL_IPS tuple take the form
if addr in INTERNAL_IPS or
if addr not in INTERNAL_IPS. This works transparently with
the IpRangeList object because it implements the magic method
which python calls when the
not in operators are used.
#!/usr/bin/env python import iptools INTERNAL_IPS = iptools.IpRangeList( '127.0.0.1', # single ip '192.168/16', # CIDR network block ('10.0.0.1', '10.0.0.19'), # arbitrary inclusive range '::1', # single IPv6 address 'fe80::/10', # IPv6 CIDR block '::ffff:172.16.0.2' # IPv4-mapped IPv6 address )
Full pydoc documentation is available at Read the Docs.
Local documentation can be built using Sphinx:
cd docs make html
Python Version Compatibility
Travis CI automatically runs tests against Python 2.7, 3.5, 3.6, 3.7, 3.8, pypy, and pypy3.
Install the latest stable version using pip:
pip install iptools
Install the latest development version:
git clone https://github.com/bd808/python-iptools.git cd python-iptools python setup.py install
Bug reports, feature requests and pull requests are accepted. Preference is given to issues with well-defined acceptance criteria and/or unit tests.
This project was originally hosted on Google Code.