Skip to main content

Converts IPv6 addresses to and from a user friendly format using words.

Project description

# ip6words [![Pypi Version][pypi-version-badge]][pypi-version-link] [![Dependency CI][dependency-ci-badge]][dependency-ci-link] [![Apache 2 License][license-badge]][license-link]

Converts IPv6 addresses to and from a user friendly format using words.

#### Usage

<p align="center">
<img src="" alt="Gif usage examples">

# Script entry point "ip6words" can be used instead of manually launching the script through python if the package was installed.
$ ip6words ::

$ ip6words -h
python ([-h] | [-d] | [-u] | [-e]) (<ip6words-address-to-convert> | <ipv6-to-convert>)
[-h] ~ This dialog
[-u] ~ The usage dialog
[-d] ~ Delete the dilled (pickled) word list in order to regenerate it before executing
[-e] ~ Explode the results instead of compressing them

#### Install

pip install ip6words

#### Requirements

- Python 3.3+ (NOT tested at all on Python 2)
- nltk <sub>(*will download these packages on first run that doesn't use dill, download them yourself beforehand if you'd like to choose the download directory*)</sub>
+ words - <sub>*optional* ~ see note #3</sub>
+ brown - <sub>*optional* ~ see note #3</sub>
+ abc - <sub>*optional* ~ see note #3</sub>
+ inaugural - <sub>*optional* ~ see note #3</sub>
+ genesis - <sub>*optional* ~ see note #3</sub>
- dill

#### Notes

1. This is designed to have the same words always point to the same IP and vice versa. The only thing that
would alter this would be a change in the base nltk data, causing a shift in the frequency of words.
2. Included with this tool is a dilled (or pickled) word list. If you wish to re-generate that dill you
must delete the file or run using the \[-d] argument.
3. In practice, this means you will actually never have to download the nltk packages yourself if you never
use the \[-d] argument and thus always load the wordlist from the dill.


Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution (430.7 kB view hashes)

Uploaded source

Built Distribution

ip6words-1.1.5-py3-none-any.whl (424.8 kB view hashes)

Uploaded 3 5

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page