Metadata-Version: 2.1
Name: aggregate-prefixes
Version: 0.7.0
Summary: 
Author: Marco Marzetti
Author-email: marco@lamehost.it
Requires-Python: >=3.9,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Description-Content-Type: text/markdown

# aggregate-prefixes
Fast IPv4 and IPv6 prefix aggregator written in Python.  

Gets a list of unsorted IPv4 or IPv6 prefixes from argument or SDTIN and returns a sorted list of aggregates to STDOUT
Errors go to STDERR.

# Install
```
git clone https://github.com/lamehost/aggregate-prefixes.git
cd aggregate_prefixes
poetry build
pip install dist/aggregate_prefixes-0.7.0-py3-none-any.whl
```

# CLI Syntax for executable
```
usage: aggregate-prefixes [-h] [--max-length LENGTH] [--strip-host-mask] [--truncate MASK] [--verbose] [--version] [prefixes]

Aggregates IPv4 or IPv6 prefixes from file or STDIN

positional arguments:
  prefixes              Text file of unsorted list of IPv4 or IPv6 prefixes. Use '-' for STDIN.

options:
  -h, --help            show this help message and exit
  --max-length LENGTH, -m LENGTH
                        Discard longer prefixes prior to processing
  --strip-host-mask, -s
                        Do not print netmask if prefix is a host route (/32 IPv4, /128 IPv6)
  --truncate MASK, -t MASK
                        Truncate IP/mask to network/mask
  --verbose, -v         Display verbose information about the optimisations
  --version, -V         show program's version number and exit
```

# Usage as module
```
$ python
Python 3.9.1+ (default, Feb  5 2021, 13:46:56)
[GCC 10.2.1 20210110] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>>
>>> from aggregate_prefixes import aggregate_prefixes
>>> list(aggregate_prefixes(['192.0.2.0/32', '192.0.2.1/32', '192.0.2.2/32']))
['192.0.2.0/31', '192.0.2.2/32']
>>>
```

# Python version compatibility
Tested with:
 - Python 3.9
 - Python 3.10
 - Python 3.11

