README.rst
1netaddr
2=======
3
4A system-independent network address manipulation library for Python 2.7 and 3.5+.
5(Python 2.7 and 3.5 support is deprecated).
6
7.. image:: https://codecov.io/gh/netaddr/netaddr/branch/master/graph/badge.svg
8 :target: https://codecov.io/gh/netaddr/netaddr
9.. image:: https://github.com/netaddr/netaddr/workflows/CI/badge.svg
10 :target: https://github.com/netaddr/netaddr/actions?query=workflow%3ACI+branch%3Amaster
11.. image:: https://img.shields.io/pypi/v/netaddr.svg
12 :target: https://pypi.org/project/netaddr/
13.. image:: https://img.shields.io/pypi/pyversions/netaddr.svg
14 :target: pypi.python.org/pypi/netaddr
15
16Provides support for:
17
18Layer 3 addresses
19
20- IPv4 and IPv6 addresses, subnets, masks, prefixes
21- iterating, slicing, sorting, summarizing and classifying IP networks
22- dealing with various ranges formats (CIDR, arbitrary ranges and
23 globs, nmap)
24- set based operations (unions, intersections etc) over IP addresses
25 and subnets
26- parsing a large variety of different formats and notations
27- looking up IANA IP block information
28- generating DNS reverse lookups
29- supernetting and subnetting
30
31Layer 2 addresses
32
33- representation and manipulation MAC addresses and EUI-64 identifiers
34- looking up IEEE organisational information (OUI, IAB)
35- generating derived IPv6 addresses
36
37Starting with Python 3.3 there's an `ipaddress <https://docs.python.org/3/library/ipaddress.html>`_
38module in the Python standard library which provides layer 3 address manipulation
39capabilities overlapping ``netaddr``.
40
41Documentation
42-------------
43
44Latest documentation https://netaddr.readthedocs.io/en/latest/
45
46Share and enjoy!
47
