О проекте

FakerRussia — программная библиотека для генерации реалистичных персональных данных, адаптированных к российской специфике. Предназначена для тестирования программного обеспечения, наполнения баз данных тестовыми наборами информации, создания демонстрационных стендов, проведения нагрузочных испытаний, а также для любых иных сценариев, требующих наличия правдоподобных персональных данных, соответствующих российским реалиям.

Библиотека обеспечивает генерацию комплексного профиля человека, включающего биографические сведения, адресные данные, контактную информацию, документальные данные, финансовые показатели, сведения о трудовой деятельности, транспортные данные и семейное положение. Все генерируемые характеристики находятся в логической взаимосвязи друг с другом, что обеспечивает высокую степень реалистичности итогового результата.

Возможности

Требования к окружению

Установка

git clone https://github.com/waratecs123/FakerRussia.git
cd FakerRussia
pip install .

Все данные встроены в пакет (регионы, города, улицы, имена, банки, болезни). Дополнительных зависимостей не требуется.

Архитектура проекта

FakerRussia/
├── __init__.py                     # Точка входа, класс FakerRussia
├── b_a__address_generator.py       # Генерация адресных данных
├── b_b__bio_generator.py           # Генерация биографических данных
├── b_c__contact_generator.py       # Генерация контактных данных
├── b_d__document_generator.py      # Генерация документальных данных
├── b_e__finance_generator.py       # Генерация финансовых данных
├── b_f__work_generator.py          # Генерация рабочих данных
├── b_g__vehicle_generator.py       # Генерация транспортных данных
├── b_h__base_generator.py          # Базовый класс для всех генераторов
├── b_i__family_generator.py        # Генерация семейных данных
├── a__data/                        # Директория исходных данных (JSON)
└── b__additional_algorithms/       # Вспомогательные алгоритмы

Диаграмма зависимостей модулей

FakerRussia (главный класс)
    │
    ├── BioGenerator
    ├── AddressGenerator
    ├── WorkGenerator ───────────────► BioGenerator
    ├── ContactGenerator ────────────► BioGenerator, AddressGenerator
    ├── VehicleGenerator ────────────► BioGenerator, AddressGenerator
    ├── DocumentGenerator ───────────► BioGenerator, AddressGenerator, VehicleGenerator
    ├── FinanceGenerator ────────────► BioGenerator, AddressGenerator, DocumentGenerator, WorkGenerator
    └── FamilyGenerator ─────────────► BioGenerator, FinanceGenerator

Руководство по использованию

Инициализация генератора

from FakerRussia import FakerRussia

generator = FakerRussia()

Указание пола

male_generator = FakerRussia(my_gender="male")
female_generator = FakerRussia(my_gender="female")

Получение полного профиля

generator = FakerRussia()
print(generator)

Доступ к категориям данных

Работа со списковыми значениями

generator = FakerRussia()

# Возвращает список Python
vaccinations_list = generator.bio.vaccinations()

# Возвращает строку с элементами через запятую
vaccinations_str = generator.bio.vaccinations(visualization=True)

Сброс данных

generator.reset()  # Полная перегенерация всех данных

Генераторы (полный API)

BioGenerator

AddressGenerator

ContactGenerator

DocumentGenerator

FinanceGenerator

WorkGenerator

VehicleGenerator

FamilyGenerator

Алгоритмы генерации

Вероятностные механизмы

Примеры сгенерированных данных

Биографические данные

ФИО: Иванов Иван Иванович
Год рождения: 15.05.1990
Возраст: 34
Пол: male
ФИО отца: Иванов Иван Петрович
ФИО матери: Иванова (девичья фамилия - Петрова) Мария Ивановна
Национальность: Русский
Рост: 178
Вес: 82
Индекс массы тела: 25.87
Знак зодиака: Телец
Поколение: Миллениалы
Группа крови: A (II) Rh+
Религия: Православие
Телосложение: Нормальное
Цвет глаз: Карие
Цвет волос: Русые
Образование: Высшее
Средний балл школьного аттестата: 4.32
Размер обуви: 43
Зрение: -2.5
Уровень слуха: Нормальный
Инвалидность: Отсутствует
Пульс в покое: 72
Прививки: Гепатит B, Корь, Грипп
Военная категория годности: Б

Адресные данные

Регион: Московская область
Город: Москва
Улица: Тверская
Адрес регистрации: 101000, Московская область - Город Москва - Тверская д. 25 корп. 3
Фактический адрес: 101000, Московская область - Город Москва - Тверская д. 25 корп. 3
Тип жилья: Квартира

Финансовые данные

БИК: 044525974
Количество карт: 2
Банки: Сбербанк, Тинькофф
Номера карт: 4276123456789012, 5213245678901234
CVV/CVC: 123, 456
Зарплата: 85000
Банкротство: False

Расширение функциональности

Для создания собственного генератора необходимо унаследоваться от BaseGenerator:

import random
from FakerRussia.b_h__base_generator import BaseGenerator
from FakerRussia.b__additional_algorithms.a_a__handle_errors import handle_errors

class CustomGenerator(BaseGenerator):
    def __init__(self):
        super().__init__()
        self._data = None
        self._load_custom_data()

    def _load_custom_data(self):
        data = self._load_json('a__data/custom/custom_data.json')
        self.CUSTOM_DATA = data.get("CUSTOM_DATA", [])

    @property
    @handle_errors
    def custom_property(self) -> str:
        if self._data is None:
            self._data = random.choice(self.CUSTOM_DATA)
        return self._data

    def reset(self):
        self._data = None
        return "Данные сброшены"