diff options
Diffstat (limited to '')
-rw-r--r-- | docs/source/reference.rst | 33 | ||||
-rw-r--r-- | docs/source/reference/compatibility.rst | 39 | ||||
-rw-r--r-- | docs/source/references.rst | 113 |
3 files changed, 185 insertions, 0 deletions
diff --git a/docs/source/reference.rst b/docs/source/reference.rst new file mode 100644 index 0000000..b8107e7 --- /dev/null +++ b/docs/source/reference.rst @@ -0,0 +1,33 @@ +Reference +========= + +The pages in this section contain technical description of various parts of netaddr machinery. + +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 + +.. toctree:: + :maxdepth: 1 + + reference/compatibility + api + changes + references + copyright + license diff --git a/docs/source/reference/compatibility.rst b/docs/source/reference/compatibility.rst new file mode 100644 index 0000000..64072ab --- /dev/null +++ b/docs/source/reference/compatibility.rst @@ -0,0 +1,39 @@ +Compatibility +============= + +Supported Python versions +------------------------- + +netaddr supports the following Python versions (CPython and PyPy): + +* 2.7 +* 3.5 +* 3.6 +* 3.7 +* 3.8 +* 3.9 +* 3.10 +* 3.11 +* 3.12 + +Support for the following versions is **deprecated and will be removed** (likely +in netaddr 1.0): + +* 2.7 +* 3.5 +* 3.6 + +Support **deprecated and scheduled to be removed** in netaddr 2: + +* 3.7 + +Supported operating systems +--------------------------- + +The library is operating system-independent. + + +Supported hardware architectures +-------------------------------- + +The library is hardware architecture-independent. diff --git a/docs/source/references.rst b/docs/source/references.rst new file mode 100644 index 0000000..01109cc --- /dev/null +++ b/docs/source/references.rst @@ -0,0 +1,113 @@ +======================== +Standards and References +======================== + +The following references are applicable to the netaddr library. + +---- +RFCs +---- + +The following RFCs have guided netaddr's feature set and capabilities. + +^^^^ +IPv4 +^^^^ + +RFC 791 - Internet Protocol + - http://www.ietf.org/rfc/rfc791 + +RFC 1918 - Address Allocation for Private Internets + - http://www.ietf.org/rfc/rfc1918 + +RFC 3330 - Special-Use IPv4 Addresses + - http://www.ietf.org/rfc/rfc3330 + +RFC 3927 - Dynamic Configuration of IPv4 Link-Local Addresses + - http://www.ietf.org/rfc/rfc3927 + +^^^^^^^^^^^^^^^^ +Multicast (IPv4) +^^^^^^^^^^^^^^^^ + +RFC 2365 - Administratively Scoped IP Multicast + - http://www.ietf.org/rfc/rfc2365 + +RFC 3171 - IANA IPv4 Multicast Guidelines + - http://www.ietf.org/rfc/rfc3171 + +RFC 3927 - Dynamic Configuration of IPv4 Link-Local Addresses + - http://www.ietf.org/rfc/rfc3927 + +^^^^ +IPv6 +^^^^ + +RFC 3330 - Special-Use IPv4 Addresses + - http://www.ietf.org/rfc/rfc3330 + +RFC 4291 - IPv6 Addressing Architecture + - http://www.ietf.org/rfc/rfc4291 + +RFC 3306 - Unicast-Prefix-based IPv6 Multicast + - http://www.ietf.org/rfc/rfc3306 + +RFC 3956 - The RP Address in IPv6 Multicast Address + - http://www.ietf.org/rfc/rfc3956 + +RFC 3879 - Deprecating Site Local Addresses + - http://www.ietf.org/rfc/rfc3879 + +RFC 4193 - Unique Local IPv6 Unicast Addresses + - http://www.ietf.org/rfc/rfc4193 + +RFC 4941 - Privacy Extensions for Stateless Address + - http://www.ietf.org/rfc/rfc4941 + +RFC 1924 - A Compact Representation of IPv6 Addresses + - http://www.ietf.org/rfc/rfc1924 + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Classless Inter-Domain Routing (CIDR) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +RFC 1338 - Supernetting: an Address Assignment and Aggregation Strategy + - http://www.ietf.org/rfc/rfc1338 + +RFC 4632 - Classless Inter-domain Routing (CIDR): The Internet Address Assignment and Aggregation Plan + - http://www.ietf.org/rfc/rfc4632 + +------------ +Data Sources +------------ + +Data from the following sources is exposed via the netaddr API. + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Internet Assigned Numbers Authority (IANA) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +IANA Protocol Registry + - http://www.iana.org/protocols/ + +IPv4 Address Space + - http://www.iana.org/assignments/ipv4-address-space + +IPv6 Address Space + - http://www.iana.org/assignments/ipv6-address-space + +Multicast Registrations + - http://www.iana.org/assignments/multicast-addresses + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Institute of Electrical and Electronics Engineers (IEEE) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +IEEE Organisation Registry + - http://standards.ieee.org/regauth/oui/index.shtml + +OUI (Organisationally Unique Identifier) Registrations + - http://standards.ieee.org/regauth/oui/oui.txt + +IAB (Individual Address Block) Registrations + - http://standards.ieee.org/regauth/oui/iab.txt |