phone-gen

Phone Gen

International phone number generation

This module was created exclusively for generating test data

Installation

Install using pip with

pip install phone-gen

Example

from phone_gen import PhoneNumber

phone_number = PhoneNumber("GB")  # ISO 3166-2
# or
phone_number = PhoneNumber("GBR")  # ISO 3166-3
# or
phone_number = PhoneNumber("Great Britain")  # Country name

# Get a phone number
number = phone_number.get_number()
print(number)  # [phone]

# Get a country code
country_code = phone_number.get_code()
print(country_code)  # 44

# Get a phone number without a country code
number = phone_number.get_number(full=False)
print(number)  # 183782623

# Get a mobile phone number
number = phone_number.get_mobile()
print(number)  # [phone]

# Get a national phone number
number = phone_number.get_national()
print(number)  # [phone]

pytest fixture

import pytest
from phone_gen import PhoneNumber


@pytest.fixture
def phone_number():
    def wrap(code):
        return PhoneNumber(code).get_number()

    yield wrap


def test_one(phone_number):
    number = phone_number("DE")
    ...

Using the CLI

usage: phone-gen [-h] [-v] [-n] country [country ...]

International phone number generation

positional arguments:
  country         Country code or country name. Example: "GB" or "GBR" or "Great Britain"

optional arguments:
  -h, --help      show this help message and exit
  -v, --version   show program's version number and exit
  -f, --not-full  Get a phone number without a country code
  -m, --mobile    Get mobile phone number
  -n, --national  Get national phone number

Example

# Get a phone number

$ phone-gen DE
[phone]

$ phone-gen DEU
[phone]

$ phone-gen Germany
[phone]


# Get a phone number without a country code
$ phone-gen -f DE
66999511

$ phone-gen -f Germany
877595

# Get mobile phone number
$ phone-gen -m DE
[phone]

# Get national phone number
$ phone-gen -n DE
+4940381

Resources

• Google's libphonenumber

Changelog

• Releases

Contributing

Contributions are very welcome.

You might want to:

• Fix spelling errors
• Improve documentation
• Add tests for untested code
• Add new features
• Fix bugs

Getting started

• python 3.12
• pipenv 2023.11.15+

1. Clone the repository

   git clone https://github.com/tolstislon/phone-gen.git
   cd phone-gen
   

2. Install dev dependencies

   pipenv install --dev
   pipenv shell
   

3. Run black

   pipenv run black
   

4. Run flake8

   pipenv run flake
   

5. Run the tests

   pipenv run tests