Advanced network calculator and address planning helper
Project description
Advanced network calculator and address planning helper.
NetCalc is a tool made by network admins, for network admins. It supports adding (aggregating) networks, subtracting a network from a larger network, doing addition and subtraction of multiple networks at once, and more functionality is to come in future releases.
NetCalc supports both IPv4 and IPv6, and works very efficiently even with very large networks. It uses the excellent netaddr library for the core address manipulation.
This program requires either Python 3 (recommended) or Python 2.
Usage
Using NetCalc is quite simple. There are four main commands:
- add
Add networks, aggregating as much as possible.
$ netcalc add 198.18.0.0/24 198.18.1.0/24 10.1/16 10/16 10.0.0.0/15 198.18.0.0/23
- sub
Subtract a network from another, splitting as necessary.
$ netcalc sub 192.0.2.0/24 192.0.2.0/28 192.0.2.16/28 192.0.2.32/27 192.0.2.64/26 192.0.2.128/25
- split
Split a network into subnets of a certain length.
$ netcalc split 198.18.64.0/18 20 198.18.64.0/20 198.18.80.0/20 198.18.96.0/20 198.18.112.0/20
- expr
Add and subtract networks using an arbitrarily long mathematical expression.
$ netcalc expr 2001:db8::/34 - 2001:db8::/38 + 2001:db8:100::/41 2001:db8:100::/41 2001:db8:400::/38 2001:db8:800::/37 2001:db8:1000::/36 2001:db8:2000::/35
Reading arguments from a text file
Arguments can also be read from a text file, one per line, by referencing the file with a @.
This allows things like adding networks from a text file, or calculating arbitrarily long expressions.
For example, given the following file:
- networks.txt
198.18.0.0/24 198.18.1.0/24 10.1/16 10/16
These networks could be added like so:
$ netcalc add @networks.txt 10.0.0.0/15 198.18.0.0/23
Or, given the file:
- /tmp/math.txt
2001:db8::/34 - 2001:db8::/38 + 2001:db8:100::/41
This expression could be calculated like so:
$ netcalc expr @/tmp/math.txt 2001:db8:100::/41 2001:db8:400::/38 2001:db8:800::/37 2001:db8:1000::/36 2001:db8:2000::/35
Installing
Using pip
The easiest way to install NetCalc is through the official Python Package Index, using a package manager such as pip:
$ sudo pip install netcalc
This will install NetCalc globally, and take care of installing all necessary dependencies first.
It is also possible to install only to the local user’s environment, without changing the global system:
$ pip install --user netcalc
This will install NetCalc in the user’s environment, which can be e.g. in ~/.local in GNU/Linux, UNIX and Mac OSX, or %APPDATA%\Python in Windows. You will need to run netcalc from within the user environment: on GNU/Linux for example, this will be ~/.local/bin/netcalc.
From source
NetCalc can also be run directly from the source directory, as long as the requirements are already installed.
The only requirement is netaddr. On a Debian or Ubuntu system, install the python3-netaddr package (for Python 3), or python-netaddr (for Python 2). On a Gentoo system, install dev-python/netaddr.
To run from source, just execute ./netcalc.py from within the root of the source directory:
$ cd netcalc $ ./netcalc.py add 10.0.0.24/29 10.0.0.16/29 10.0.0.16/28
Future plans
Future plans for NetCalc include, in no particular order:
new command for static information (netmask/bitmask, IP range)
new command for WHOIS queries
make expr command more generic, allow e.g. splitting subnets
ability to read networks from file in different formats (CSV, etc.)
create packages for common GNU/Linux distributions, and installer for Windows
???
Suggestions are quite welcome :)
Contact
NetCalc is developed by Israel G. Lugo <israel.lugo@lugosys.com>. Main repository for cloning, submitting issues and/or forking is at https://github.com/israel-lugo/netcalc
License
Copyright (C) 2016 Israel G. Lugo <israel.lugo@lugosys.com>
NetCalc is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
NetCalc is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with NetCalc. If not, see <http://www.gnu.org/licenses/>.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for netcalc-0.3.1-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ce1e953d1fba9cbe2c911cb7ee092e6878c5cf85ae1a551027637ca31ef80d2b |
|
| MD5 | 6dd800dab346b4acc65482e7dd6c2b7d |
|
| BLAKE2b-256 | 2d55c72804c45253ea652441ad3beab8ca0026963ba0b2151c8d6c3bee29fa93 |
