louisronron / pynetcal

A super-easy IPv4, IPv6 network calculator for your CLI
GNU General Public License v3.0
1 stars 1 forks source link

PyNetcal

PyNetcal

1.0. Introduction

PyNetcal is a simple IPv4, IPv6 network calculator, written in Python for your CLI. So, once upon a time I decided to have some fun and explore networking tools, and then decided to experiment with a simple subnet calculator; one that's a little simpler than Sipcalc, which may seem a bit too advanced for users without subnetting experience. Enjoy!

2.0. Feature Summary

3.0. Installation

3.1. Installers

Install packages have been tested on Windows and Linux Ubuntu.

Once you've installed PyNetcal successfuly, go to Usage to see some commands to get you started. Enjoy!

3.2. Build from source

Requirements

Steps

Building the project from source has been tested successfully in Ubuntu, and Windows.

  1. Install the latest version of Python

  2. Install the latest version of pip.

  3. Open a terminal and clone the git repository

    $ git clone https://github.com/louisronron/pynetcal

    Alternatively, you can download source zip, and unzip it to a working location on your local machine.

  4. We will need to install a couple of Python dependencies using pip. Luckily, all the dependencies are pre-written in the pyrequirements.txt file so not much typing for you to do here. In the terminal, navigate to the root of the cloned repo, and enter

    $ pip install -r pyrequirements.txt
  5. Then, initiate the build process using

    $ python build.py

    The build process generates a couple of things, among them two new directories /dist and /build in the root directory.

  6. In the new /dist directory, copy the new pynetcal executable created to any location on your machine, and add that location to your environment's PATH variable.

You're all set!

To confirm that you've done things correctly, open a new terminal and enter

$ pynetcal version

4.0. Usage

Up to this point, you should have PyNetcal successfully installed!

Head over to Usage for all the "how to use PyNetcal" content :)