Release history and notes

Sequence based identifiers are used for versioning (schema follows below):

major.minor[.revision]

  • It’s always safe to upgrade within the same minor version (for example, from 0.3 to 0.3.4).

  • Minor version changes might be backwards incompatible. Read the release notes carefully before upgrading (for example, when upgrading from 0.3.4 to 0.4).

  • All backwards incompatible changes are mentioned in this document.

0.10.5

2024-11-23

  • Add benchmarks section to the main README.

  • Improve docs. Add a dedicated section on files creation.

  • Test against Django 5.1.

  • Clean-up.

0.10.4

2024-10-17

  • Add a separator argument to the slugify function.

  • Minor documentation improvements.

0.10.3

2024-10-16

  • Add JPG file support through jpg and jpg_file providers.

0.10.2

2024-10-07

  • Test against Python 3.13 and 3.14.

  • Upgrade GitHub Actions.

0.10.1

2024-10-05

  • Added password provider.

0.10

2024-09-27

  • For both StringTemplate and LazyStringTemplate the faker argument had become optional and positionally moved from first to the last place.

  • Improve string templates.

  • Minor documentation improvements.

0.9.9

2024-09-27

  • Improve string templates.

  • Minor documentation improvements.

0.9.8

2024-09-26

  • Implement string templates.

  • Minor documentation improvements.

0.9.7

2024-09-17

  • Minor (documentation) fixes.

0.9.6

2024-09-16

  • Add ZIP file support through zip and zip_file providers.

  • Add TAR file support through tar and tar_file providers.

  • Add EML file support through eml and eml_file providers.

  • Add inner file functions for creating archive files with unlimited depth.

0.9.5

2024-09-11

  • Minor optimisations.

0.9.4

2024-08-18

  • Add WAV audio file support through wav and wav_file providers.

0.9.3

2024-08-09

  • Prepare for namespaced packages. fakepy is now an additional registered namespace, next to fake. All integration packages can make use of the fakepy namespace. For instance:

    from fake import FAKER
from fakepy.pathy_storage.aws_s3 import AWSS3Storage

STORAGE = AWSS3Storage(
    bucket_name="bucket_name",
    root_path="tmp",  # Optional
    rel_path="sub-tmp",  # Optional
)

txt_file = FAKER.txt_file(storage=STORAGE)

STORAGE.exists(txt_file)

0.9.2

2024-08-05

  • Implement randomise_string provider, that replaces placeholders in a given string with random letters and digits. Placeholders ? are replaced by random uppercase letters, and placeholders # are replaced by random digits.

0.9.1

2024-08-04

  • Minor fixes.

0.9

2024-08-03

  • Drop support for EOL Python 3.7 and almost EOL 3.8.

  • Add country support through country provider.

  • Add city support through city provider.

  • Add geo-location support through geo_location provider.

  • Add latitude/longitude support through latitude, longitude and latitude_longitude providers.

0.8.4

2024-08-01

  • Added ISBN support through isbn10 and isbn13 providers.

  • Added country code support through country_code provider.

  • Added locale support through locale provider.

  • Added IBAN support through iban provider.

0.8.3

2024-07-27

  • Added mime_type provider.

0.8.2

2024-07-27

  • Added file_extension provider.

0.8.1

2024-07-24

  • Added ODT file support through odt and odt_file providers.

0.8

2024-07-24

  • The extension argument is renamed to image_format argument for png_file, svg_file, bmp_file and gif_file providers. The extension argument serves now solely a purpose of providing the actual file extension and it’s optional (None by default). If not given, the image_format value is used for file extension instead.

  • Minor fixes in generation of image files.

  • Added TIF support through tif and tif_file providers.

0.7.5

2024-07-04

  • Improve text PDF generation according to 1.4 (most common) spec instead of 1.0.

0.7.4

2024-06-28

  • Add CLI.

0.7.3

2024-06-21

Note

Release dedicated to my dear son Tigran, who turned 12 today.

  • Add text_pdf and text_pdf_file providers, which are shortcuts for pdf and pdf_file with generator set to TextPdfGenerator.

  • Allow to optionally tag providers.

  • Tag all implemented providers.

0.7.2

2024-06-17

  • Add basic slugify function.

  • Minor fixes in free_email and company_email providers.

0.7.1

2024-06-11

  • Test against SQLModel. Also included SQLModel examples.

  • Improve docs.

0.7

2024-06-09

Note

This release contains minor backwards incompatible changes. Namely, in the email provider.

  • The domain (type: str, default value: example.com) argument of the email provider has been dropped in favour of domain_names (type: Optional[Tuple[str], default value: None).

  • Added a dedicated PydanticModelFactory (yet equal to ModelFactory) for future improvements.

  • Added PreInit factory class and pre_init decorator.

  • Improved documentation of factories.

  • Added random_choice and random_sample providers.

  • Added tld, domain_name, free_email_domain, company_email and free_email providers.

0.6.9

2024-05-10

  • Minor fixes in pdf_file and docx_file providers.

  • Minor fixes in docs.

0.6.8

2024-05-06

  • Minor fixes in docs.

0.6.7

2024-01-17

  • Add uuids, first_names, last_names, names, usernames and slugs plural providers (return List).

0.6.6

2024-01-15

  • Add image_url provider.

0.6.5

2023-12-18

  • Improve docs.

  • MyPy fixes.

0.6.4

2023-12-16

  • Add PreSave and PostSave.

0.6.3

2023-12-13

  • Add LazyAttribute and LazyFunction.

  • Improve package portability (tests).

  • Improve tests.

0.6.2

2023-12-11

  • Add SQLAlchemyModelFactory.

0.6.1

2023-12-10

  • Allow to load registered Faker instance by uid or alias.

  • Improve test coverage.

0.6

2023-12-09

  • Add optional argument alias to the Faker class.

  • Improve multiple Faker instances.

  • Add generic_file provider.

0.5

2023-12-08

  • Make fake.Faker and fake.Factory classes more customizable.

  • Introduce provider decorator to decorate provider methods.

  • Documentation improvements.

0.4.1

2023-12-07

  • Added pydecimal.

  • Make date_time timezone aware.

  • Added documentation on how to customize.

0.4

2023-12-06

  • Streamline on how to use traits, pre- and post-save hooks.

0.3.1

2023-12-04

  • Improve Tortoise ORM factory.

  • Add traits.

  • Improve documentation.

0.3

2023-12-03

  • Added factories.

  • Added mechanism to clean-up (remove) the created test files.

  • Improved documentation.

0.2

2023-12-01

  • Add factories.

  • Improve docs.

  • Add uuid, slug and username generators.

  • Change date_between to date.

  • Change date_time_between to date_time.

0.1.3

2023-11-28

  • Added pdf_file, docx_file, png_file, svg_file, bmp_file, gif_file support.

  • Added storages.

0.1.2

2023-11-26

  • Adding texts support.

  • Improve tests and documentation.

0.1.1

2023-11-26

  • Adding DOCX support.

  • Fixes in documentation.

0.1

2023-11-25

  • Initial beta release.