
Welcome to Faker's documentation!
*********************************

   _|_|_|_|          _|
   _|        _|_|_|  _|  _|      _|_|    _|  _|_|
   _|_|_|  _|    _|  _|_|      _|_|_|_|  _|_|
   _|      _|    _|  _|  _|    _|        _|
   _|        _|_|_|  _|    _|    _|_|_|  _|

*Faker* is a Python package that generates fake data for you. Whether
you need to bootstrap your database, create good-looking XML
documents, fill-in your persistence to stress test it, or anonymize
data taken from a production service, Faker is for you.

Faker is heavily inspired by PHP's Faker, Perl's Data::Faker, and by
ruby's Faker.

======================================================================

[image: Latest version released on PyPi][image] [image: Build status
of the master branch on Mac/Linux][image] [image: Build status of the
master branch on Windows][image] [image: Test coverage][image] [image:
Monthly downloads][image] [image: Package license][image]

======================================================================


Basic Usage
===========

Install with pip:

   pip install fake-factory

Use "faker.Factory.create()" to create and initialize a faker
generator, which can generate data by accessing properties named after
the type of data you want.

   from faker import Factory
   fake = Factory.create()

   # OR
   from faker import Faker
   fake = Faker()

   fake.name()
   # 'Lucy Cechtelar'

   fake.address()
   # "426 Jordy Lodge
   #  Cartwrightshire, SC 88120-6700"

   fake.text()
   # Sint velit eveniet. Rerum atque repellat voluptatem quia rerum. Numquam excepturi
   # beatae sint laudantium consequatur. Magni occaecati itaque sint et sit tempore. Nesciunt
   # amet quidem. Iusto deleniti cum autem ad quia aperiam.
   # A consectetur quos aliquam. In iste aliquid et aut similique suscipit. Consequatur qui
   # quaerat iste minus hic expedita. Consequuntur error magni et laboriosam. Aut aspernatur
   # voluptatem sit aliquam. Dolores voluptatum est.
   # Aut molestias et maxime. Fugit autem facilis quos vero. Eius quibusdam possimus est.
   # Ea quaerat et quisquam. Deleniti sunt quam. Adipisci consequatur id in occaecati.
   # Et sint et. Ut ducimus quod nemo ab voluptatum.

Each call to method "fake.name()" yields a different (random) result.
This is because faker forwards "faker.Generator.method_name()" calls
to "faker.Generator.format(method_name)".

   for _ in range(0,10):
     print fake.name()

       # Adaline Reichel
       # Dr. Santa Prosacco DVM
       # Noemy Vandervort V
       # Lexi O'Conner
       # Gracie Weber
       # Roscoe Johns
       # Emmett Lebsack
       # Keegan Thiel
       # Wellington Koelpin II
       # Ms. Karley Kiehn V


Providers
=========

Each of the generator properties (like "name", "address", and "lorem")
are called "fake". A faker generator has many of them, packaged in
"providers". Here is a list of the bundled formatters in the default
locale.


Localization
============

"faker.Factory" can take a locale as an argument, to return localized
data. If no localized provider is found, the factory falls back to the
default en_US locale.

   from faker import Factory
   fake = Factory.create('it_IT')
   for _ in range(0,10):
       print fake.name()

   > Elda Palumbo
   > Pacifico Giordano
   > Sig. Avide Guerra
   > Yago Amato
   > Eustachio Messina
   > Dott. Violante Lombardo
   > Sig. Alighieri Monti
   > Costanzo Costa
   > Nazzareno Barbieri
   > Max Coppola

You can check available Faker locales in the source code, under the
providers package. The localization of Faker is an ongoing process,
for which we need your help. Please don't hesitate to create a
localized provider for your own locale and submit a Pull Request (PR).

Included localized providers:

* bg_BG - Bulgarian

* cs_CZ - Czech

* de_DE - German

* dk_DK - Danish

* el_GR - Greek

* en_AU - English (Australia)

* en_CA - English (Canada)

* en_GB - English (Great Britain)

* en_US - English (United States)

* es_ES - Spanish (Spain)

* es_MX - Spanish (Mexico)

* fa_IR - Persian (Iran)

* fi_FI - Finnish

* fr_FR - French

* hi_IN - Hindi

* it_IT - Italian

* ko_KR - Korean

* lt_LT - Lithuanian

* lv_LV - Latvian

* ne_NP - Nepali

* nl_NL - Dutch (Netherlands)

* no_NO - Norwegian

* pl_PL - Polish

* pt_BR - Portuguese (Brazil)

* pt_PT - Portuguese (Portugal)

* ru_RU - Russian

* sk_SK - Slovak

* sl_SI - Slovene

* sv_SE - Swedish

* tr_TR - Turkish

* zh_CN - Chinese (China)

* zh_TW - Chinese (Taiwan)


Command line usage
==================

When installed, you can invoke faker from the command-line:

   faker [-h] [--version] [-o output]
         [-l {bg_BG,cs_CZ,...,zh_CN,zh_TW}]
         [-r REPEAT] [-s SEP]
         [fake [fake ...]]

Where:

* "faker": is the script when installed in your environment, in
  development you could use "python -m faker" instead

* "-h", "--help": shows a help message

* "--version": shows the program's version number

* "-o FILENAME": redirects the output to the specified filename

* "-l {bg_BG,cs_CZ,...,zh_CN,zh_TW}": allows use of a localized
  provider

* "-r REPEAT": will generate a specified number of outputs

* "-s SEP": will generate the specified separator after each
  generated output

* "fake": is the name of the fake to generate an output for, such as
  "name", "address", or "text"

* "[fake ...]": is an optional comma-separated list of field names
  to pass to the fake, such as "ssn,birthday" when the "profile" fake
  is used

Examples:

   $ faker address
   968 Bahringer Garden Apt. 722
   Kristinaland, NJ 09890

   $ faker -l de_DE address
   Samira-Niemeier-Allee 56
   94812 Biedenkopf

   $ faker profile ssn,birthdate
   {'ssn': u'628-10-1085', 'birthdate': '2008-03-29'}

   $ faker -r=3 -s=";" name
   Willam Kertzmann
   ;
   Josiah Maggio
   ;
   Gayla Schmitt
   ;


How to create a Provider
========================

   from faker import Faker
   fake = Faker()

   # first, import a similar Provider or use the default one
   from faker.providers import BaseProvider

   # create new provider class
   class MyProvider(BaseProvider):
       def foo(self):
           return 'bar'

   # then add new provider to faker instance
   fake.add_provider(MyProvider)

   # now you can use:
   fake.foo()
   > 'bar'


How to use with factory-boy
===========================

   import factory
   from faker import Factory as FakerFactory
   from myapp.models import Book

   faker = FakerFactory.create()


   class Book(factory.Factory):
       FACTORY_FOR = Book

       title = factory.LazyAttribute(lambda x: faker.sentence(nb_words=4))
       author_name = factory.LazyAttribute(lambda x: faker.name())


Seeding the Generator
=====================

When using Faker for unit testing, you will often want to generate the
same data set. The generator offers a  "seed()" method, which seeds
the random number generator. Calling the same script twice with the
same seed produces the same results.

   from faker import Faker
   fake = Faker()
   fake.seed(4321)

   print fake.name()
   > Margaret Boehm


Tests
=====

Run tests:

   $ python setup.py test

or

   $ python -m unittest -v faker.tests

Write documentation for providers:

   $ python -m faker > docs.txt


Contribute
==========

Please see CONTRIBUTING.


License
=======

Faker is released under the MIT License. See the bundled LICENSE file
for details.


Credits
=======

* FZaninotto / PHP Faker

* Distribute

* Buildout

* modern-package-template


Contents
========

* Providers

  * "faker.providers.address"

  * "faker.providers.barcode"

  * "faker.providers.color"

  * "faker.providers.company"

  * "faker.providers.credit_card"

  * "faker.providers.currency"

  * "faker.providers.date_time"

  * "faker.providers.file"

  * "faker.providers.internet"

  * "faker.providers.job"

  * "faker.providers.lorem"

  * "faker.providers.misc"

  * "faker.providers.person"

  * "faker.providers.phone_number"

  * "faker.providers.profile"

  * "faker.providers.python"

  * "faker.providers.ssn"

  * "faker.providers.user_agent"

* Locales

  * Language bg_BG

  * Language cs_CZ

  * Language de_AT

  * Language de_DE

  * Language dk_DK

  * Language el_GR

  * Language en

  * Language en_AU

  * Language en_CA

  * Language en_GB

  * Language en_US

  * Language es

  * Language es_ES

  * Language es_MX

  * Language fa_IR

  * Language fi_FI

  * Language fr_FR

  * Language hi_IN

  * Language it_IT

  * Language ja_JP

  * Language ko_KR

  * Language la

  * Language lt_LT

  * Language lv_LV

  * Language ne_NP

  * Language nl_NL

  * Language no_NO

  * Language pl_PL

  * Language pt_BR

  * Language pt_PT

  * Language ru_RU

  * Language sk_SK

  * Language sl_SI

  * Language sv_SE

  * Language tr_TR

  * Language uk_UA

  * Language zh_CN

  * Language zh_TW

* Coding Style

  * Encoding

  * Data Sets

  * Name Lists


Indices and tables
******************

* *Index*

* *Module Index*

* *Search Page*
