Orange-OpenSource / pn

a libphonenumber command-line wrapper

pn -- a libphonenumber command-line wrapper, and GNU AWK extension

pn is a tool that allows command line user/programmers to operate on phone numbers (get validity information, reformat them, or extract numbers from a text snippet), using libphonenumber.

This repository also contains a GNU AWK extension library, exposing some libphonenumber features in AWK. See gawkext/README.md for more details.

Features

See the man page for more details.

Check the validity of a number:

$ pn valid -v [phone]
valid number
(SUCCESS)
$ pn valid -v '[phone]'
invalid country code
(ERROR)
$ pn valid -v -c US '[phone]'
valid number
(SUCCESS)

Re-format a phone number:

$ pn format "+1 20 2 555    01 10"
[phone]
$ pn format -c FR "0123456789"
[phone]
$ pn format -c FR -f nat "0123456789"
01 23 45 67 89
$ pn format -f int "[phone]"
[phone]

Find valid numbers inside a free text input:

$ pn find -f nat "2017/04/20: You have 2 messsages, call [phone] to listen to them."
[phone]
$ pn find -c FR "rappelle-moi au 01 23 4 56789 ou au 06 78 90 12 34 après 20h00"
[phone]
[phone]

Get some informations about a number:

$ pn info "[phone]"
country code: 33 (FR)
number type: fixed line
location: Lannion
possible short number: false
valid short number: false
emergency number: false

$ pn info -c FR 112
country code: 33 (FR)
number type: unknown
location: 
possible short number: true
valid short number: true
emergency number: true

How to build pn?

Prerequisites

For Debian (>= 9), Ubuntu (>= 16.10):

$ sudo apt install cmake build-essential libphonenumber-dev libicu-dev

For Ubuntu 16.04:

$ sudo apt install cmake build-essential libphonenumber-dev libgeocoding-dev libicu-dev

Note: You might want to use a newer version of libphonenumber than the one packaged by your distribution. In that case, fetch the source code and compile it on your own, following the instructions provided here.

Other platforms:

To build pn you need a C++ compiler, CMake, Google's libphonenumber (including the geocoding part) binaries and dev headers, ICU binaries and dev headers.

Build

Provided that the prerequisites are met, to build pn and the gawk extension gawkpn.so (it is only compiled if CMake was able to locaite gawk's .h header on the system) simply issue :

pn/$ cd build
pn/build/$ cmake ..
pn/build/$ make

Install

pn/build/$ sudo make install