faker-file ¶

Generate fake files

Prerequisites ¶

All of core dependencies of this package are MIT licensed. Most of optional dependencies of this package are MIT licensed, while a few are BSD- or Apache 2 licensed. All licenses are mentioned below between the brackets.

Core package requires Python 3.7, 3.8, 3.9, 3.10 and 3.11.
Django (BSD) integration with factory_boy (MIT) has been tested with Django 2.2, 3.0, 3.1, 3.2, 4.0 and 4.1.
DOCX file support requires python-docx (MIT).
ICO, JPEG, PNG, SVG and WEBP files support requires imgkit (MIT).
PDF file support requires pdfkit (MIT).
PPTX file support requires python-pptx (MIT).
ODS file support requires tablib (MIT) and odfpy (Apache 2).
XLSX file support requires tablib (MIT) and openpyxl (MIT).
PathyFileSystemStorage storage support requires pathy (Apache 2).
AWSS3Storage storage support requires pathy (Apache 2) and boto3 (Apache 2).
AzureCloudStorage storage support requires pathy (Apache 2) and azure-storage-blob (MIT).
GoogleCloudStorage storage support requires pathy (Apache 2) and google-cloud-storage (Apache 2).

Documentation ¶

Documentation is available on Read the Docs.

Installation ¶

Latest stable version on PyPI:

pip install faker-file[all]

Or development version from GitHub:

pip install https://github.com/barseghyanartur/faker-file/archive/main.tar.gz

Supported file types ¶

BIN
CSV
DOCX
ICO
JPEG
ODS
PDF
PNG
PPTX
SVG
TXT
WEBP
XLSX
ZIP

Usage examples ¶

With `Faker`¶

One way

from faker import Faker
from faker_file.providers.txt_file import TxtFileProvider

FAKER = Faker()

file = TxtFileProvider(FAKER).txt_file()

Or another

from faker import Faker
from faker_file.providers.txt_file import TxtFileProvider

FAKER = Faker()
FAKER.add_provider(TxtFileProvider)

file = FAKER.txt_file()

With `factory_boy`¶

upload/models.py ¶

from django.db import models

class Upload(models.Model):

    # ...
    file = models.FileField()

upload/factory.py ¶

Note, that when using faker-file with Django, you need to pass your MEDIA_ROOT setting as root_path value (which is by default set to tempfile.gettempdir()).

import factory
from django.conf import settings
from factory import Faker
from factory.django import DjangoModelFactory
from faker_file.providers.docx_file import DocxFileProvider

from upload.models import Upload

factory.Faker.add_provider(DocxFileProvider)

class UploadFactory(DjangoModelFactory):

    # ...
    file = Faker("docx_file", root_path=settings.MEDIA_ROOT)

    class Meta:
        model = Upload

Supported storages ¶

All file operations are delegated to a separate abstraction layer of storages.

The following storages are implemented:

FileSystemStorage: Does not have additional requirements.
PathyFileSystemStorage: Requires pathy.
AzureCloudStorage: Requires pathy and Azure related dependencies.
GoogleCloudStorage: Requires pathy and Google Cloud related dependencies.
AWSS3Storage: Requires pathy and AWS S3 related dependencies.

Usage example with storages ¶

FileSystemStorage example ¶

Native file system storage. Does not have dependencies.

import tempfile
from faker import Faker
from faker_file.providers.txt_file import TxtFileProvider
from faker_file.storages.filesystem import FileSystemStorage

FS_STORAGE = FileSystemStorage("root_path", "rel_path")

FAKER = Faker()

file = TxtFileProvider(FAKER).txt_file(storage=FS_STORAGE)

FS_STORAGE.exists(file)

PathyFileSystemStorage example ¶

Native file system storage. Requires pathy.

import tempfile
from pathy import use_fs
from faker import Faker
from faker_file.providers.txt_file import TxtFileProvider
from faker_file.storages.cloud import PathyFileSystemStorage

use_fs(tempfile.gettempdir())
PATHY_FS_STORAGE = PathyFileSystemStorage("bucket_name", "rel_path")

FAKER = Faker()

file = TxtFileProvider(FAKER).txt_file(storage=PATHY_FS_STORAGE)

PATHY_FS_STORAGE.exists(file)

AWSS3Storage example ¶

AWS S3 storage. Requires pathy.

import tempfile
from pathy import use_fs
from faker import Faker
from faker_file.providers.txt_file import TxtFileProvider
from faker_file.storages.aws_s3 import AWSS3Storage

S3_STORAGE = AWSS3Storage(
    bucket_name="bucket_name",
    rel_path="rel_path",
    credentials={"key_id": "YOUR KEY ID", "key_secret": "YOUR KEY SECRET"},
)

FAKER = Faker()

file = TxtFileProvider(FAKER).txt_file(storage=S3_STORAGE)

S3_STORAGE.exists(file)

Testing ¶

Simply type:

pytest -vvv

Or use tox:

tox

Or use tox to check specific env:

tox -e py310-django41

Writing documentation ¶

Keep the following hierarchy.

=====
title
=====

header
======

sub-header
----------

sub-sub-header
~~~~~~~~~~~~~~

sub-sub-sub-header
^^^^^^^^^^^^^^^^^^

sub-sub-sub-sub-header
++++++++++++++++++++++

sub-sub-sub-sub-sub-header
**************************

License ¶

MIT

Support ¶

For any security issues contact me at the e-mail given in the Author section.

For overall issues, go to GitHub.

Author ¶

Artur Barseghyan <artur.barseghyan@gmail.com>

Project documentation ¶

Contents: