Generate files with fake data.
Project description
Create files with fake data. In many formats. With no efforts.
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-, Apache 2- or GPLv3 licensed. All licenses are mentioned below between the brackets.
Core package requires Python 3.7, 3.8, 3.9, 3.10 or 3.11.
Faker (MIT) is the only required dependency.
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) and wkhtmltopdf (LGPLv3).
PDF file support requires either combination of pdfkit (MIT) and wkhtmltopdf (LGPLv3), or reportlab (BSD).
PPTX file support requires python-pptx (MIT).
ODP file support requires odfpy (Apache 2).
ODS file support requires tablib (MIT) and odfpy (Apache 2).
ODT file support requires odfpy (Apache 2).
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).
AugmentFileFromDirProvider provider requires nlpaug (MIT), PyTorch (BSD), transformers (Apache 2), numpy (BSD), pandas (BSD), tika (Apache 2) and Apache Tika (Apache 2).
Documentation
Documentation is available on Read the Docs.
For bootstrapping check the Quick start.
For various ready to use code examples see the Recipes.
For CLI options see the CLI.
For guidelines on contributing check the Contributor guidelines.
Online demos
Check the demo(s):
REST API demo (based on faker-file-api REST API)
UI frontend demo (based on faker-file-ui UI frontend)
WASM frontend demo (based on faker-file-wasm WASM frontend)
Installation
Latest stable version from PyPI
WIth all dependencies
pip install faker-file[all]Only core
pip install faker-fileWith most common dependencies
Everything, except ML libraries which are required for data augmentation only
pip install faker-file[common]With DOCX support
pip install faker-file[docx]With EPUB support
pip install faker-file[epub]With images support
pip install faker-file[images]With PDF support
pip install faker-file[pdf]With MP3 support
pip install faker-file[mp3]With XLSX support
pip install faker-file[xlsx]With ODS support
pip install faker-file[ods]With ODT support
pip install faker-file[odt]With data augmentation support
pip install faker-file[data-augmentation]Or development version from GitHub
pip install https://github.com/barseghyanartur/faker-file/archive/main.tar.gzFeatures
Supported file types
BIN
CSV
DOCX
EML
EPUB
ICO
JPEG
MP3
ODS
ODT
ODP
PDF
PNG
RTF
PPTX
SVG
TAR
TXT
WEBP
XLSX
XML
ZIP
Additional providers
AugmentFileFromDirProvider: Make an augmented copy of randomly picked file from given directory. The following types are supported : DOCX, EML, EPUB, ODT, PDF, RTF and TXT.
RandomFileFromDirProvider: Pick a random file from given directory.
Supported file storages
Native file system storage
AWS S3 storage
Azure Cloud Storage
Google Cloud Storage
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()If you just need bytes back (instead of creating the file), provide the raw=True argument (works with all provider classes and inner functions):
raw = TxtFileProvider(FAKER).txt_file(raw=True)Or another
from faker import Faker
from faker_file.providers.txt_file import TxtFileProvider
FAKER = Faker()
FAKER.add_provider(TxtFileProvider)
file = FAKER.txt_file()If you just need bytes back:
raw = FAKER.txt_file(raw=True)With factory_boy
upload/models.py
from django.db import models
class Upload(models.Model):
# ...
file = models.FileField()upload/factories.py
Note, that when using faker-file with Django and native file system storages, you need to pass your MEDIA_ROOT setting as root_path value to the chosen file storage as show below.
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 faker_file.storages.filesystem import FileSystemStorage
from upload.models import Upload
FS_STORAGE = FileSystemStorage(
root_path=settings.MEDIA_ROOT,
rel_path="tmp"
)
factory.Faker.add_provider(DocxFileProvider)
class UploadFactory(DjangoModelFactory):
# ...
file = Faker("docx_file", storage=FS_STORAGE)
class Meta:
model = UploadFile 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=tempfile.gettempdir(), # Use settings.MEDIA_ROOT for Django
rel_path="tmp",
)
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="bucket_name",
root_path="tmp"
rel_path="sub-tmp",
)
FAKER = Faker()
file = TxtFileProvider(FAKER).txt_file(storage=PATHY_FS_STORAGE)
PATHY_FS_STORAGE.exists(file)AWSS3Storage example
AWS S3 storage. Requires pathy and boto3.
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",
root_path="tmp", # Optional
rel_path="sub-tmp", # Optional
# Credentials are optional too. If your AWS credentials are properly
# set in the ~/.aws/credentials, you don't need to send them
# explicitly.
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 -vrxOr use tox:
toxOr use tox to check specific env:
tox -e py310-django41Writing 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 security issues contact me at the e-mail given in the Author section.
For overall issues, go to GitHub.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file faker-file-0.14.3.tar.gz.
File metadata
- Download URL: faker-file-0.14.3.tar.gz
- Upload date:
- Size: 116.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 8dc949bec91a8ebeffc903ef304efb5878b77acf051d10b9c3aaf26765ece62f |
|
| MD5 | 6c206a0d06229405252ab70e0158f9c8 |
|
| BLAKE2b-256 | 965d3e6a34e78aa8f8e43d1c221556827742110f709cecee6b43e9adae38d862 |
Provenance
File details
Details for the file faker_file-0.14.3-py2.py3-none-any.whl.
File metadata
- Download URL: faker_file-0.14.3-py2.py3-none-any.whl
- Upload date:
- Size: 95.0 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | cd24d73cf4d21a3cc8a2dc92af5ef3f2f8f02e506e4aab7fb2794dd4601bab83 |
|
| MD5 | 7a80ec59193834f84da6307af88f6004 |
|
| BLAKE2b-256 | 8edefd31d19177f7a5f1e54af8a7e019f5ae852367ba383a523dff010f702e62 |
