https://github.com/lstn/ip6words
Utility to convert IPv6 addresses to and from a user friendly word based format
https://github.com/lstn/ip6words
human-readable-representations ipv4 ipv4-address ipv6 ipv6-address user-friendly
Last synced: 3 months ago
JSON representation
Utility to convert IPv6 addresses to and from a user friendly word based format
- Host: GitHub
- URL: https://github.com/lstn/ip6words
- Owner: lstn
- License: apache-2.0
- Created: 2016-10-14T23:24:01.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2025-04-13T16:52:49.000Z (about 1 year ago)
- Last Synced: 2025-12-16T15:07:57.198Z (6 months ago)
- Topics: human-readable-representations, ipv4, ipv4-address, ipv6, ipv6-address, user-friendly
- Language: Python
- Homepage:
- Size: 5.06 MB
- Stars: 78
- Watchers: 1
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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
```bash
# Script entry point "ip6words" can be used instead of manually launching the script through python if the package was installed.
$ ip6words ::
the8
$ ip6words -h
Usage:
python ip6words.py ([-h] | [-d] | [-u] | [-e]) ( | )
[-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
```bash
pip install ip6words
```
#### Requirements
- Python 3.3+ (NOT tested at all on Python 2)
- nltk (*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*)
+ words - *optional* ~ see note #3
+ brown - *optional* ~ see note #3
+ abc - *optional* ~ see note #3
+ inaugural - *optional* ~ see note #3
+ genesis - *optional* ~ see note #3
- 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.
[pypi-version-badge]: https://badge.fury.io/py/ip6words.svg
[pypi-version-link]: https://pypi.python.org/pypi/ip6words/
[dependency-ci-badge]: https://dependencyci.com/github/lstn/ip6words/badge
[dependency-ci-link]: https://dependencyci.com/github/lstn/ip6words
[license-badge]: https://img.shields.io/badge/license-Apache%202-blue.svg
[license-link]: https://raw.githubusercontent.com/lstn/ip6words/master/LICENSE