summaryrefslogtreecommitdiff
path: root/README.rst
blob: 356438137b58cae19744648d78225a36edfb5359 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
netaddr
=======

A system-independent network address manipulation library for Python 2.7 and 3.5+.
(Python 2.7 and 3.5 support is deprecated).

.. image:: https://codecov.io/gh/netaddr/netaddr/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/netaddr/netaddr
.. image:: https://github.com/netaddr/netaddr/workflows/CI/badge.svg
   :target: https://github.com/netaddr/netaddr/actions?query=workflow%3ACI+branch%3Amaster
.. image:: https://img.shields.io/pypi/v/netaddr.svg
   :target: https://pypi.org/project/netaddr/
.. image:: https://img.shields.io/pypi/pyversions/netaddr.svg
   :target: pypi.python.org/pypi/netaddr

Provides support for:

Layer 3 addresses

-  IPv4 and IPv6 addresses, subnets, masks, prefixes
-  iterating, slicing, sorting, summarizing and classifying IP networks
-  dealing with various ranges formats (CIDR, arbitrary ranges and
   globs, nmap)
-  set based operations (unions, intersections etc) over IP addresses
   and subnets
-  parsing a large variety of different formats and notations
-  looking up IANA IP block information
-  generating DNS reverse lookups
-  supernetting and subnetting

Layer 2 addresses

-  representation and manipulation MAC addresses and EUI-64 identifiers
-  looking up IEEE organisational information (OUI, IAB)
-  generating derived IPv6 addresses

Starting with Python 3.3 there's an `ipaddress <https://docs.python.org/3/library/ipaddress.html>`_
module in the Python standard library which provides layer 3 address manipulation
capabilities overlapping ``netaddr``.

Documentation
-------------

Latest documentation https://netaddr.readthedocs.io/en/latest/

Share and enjoy!