Add documentation for faker providers

jlane9 · Dec 18, 2019 · 25cf59f · 25cf59f
1 parent efbc5af
commit 25cf59f
Show file tree

Hide file tree

Showing 27 changed files with 1,747 additions and 9 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -53,6 +53,7 @@ Mockerena allows anyone to mock data files through customized json schemas and p
    Development <development>
    Deployment <deploy>
    Usage <usage>
+   Providers <providers/index>
    Routes <routes>
    API Reference <api>
    About Us <https://www.fanthreesixty.com/about-us/>

diff --git a/docs/providers/address.rst b/docs/providers/address.rst
@@ -0,0 +1,79 @@
+address
+=======
+
+.. code-block:: python
+
+    fake.address()
+    # '965 Walker Row\nMichelemouth, FL 07740'
+
+    fake.building_number()
+    # '84727'
+
+    fake.city()
+    # 'Alexandertown'
+
+    fake.city_prefix()
+    # 'Lake'
+
+    fake.city_suffix()
+    # 'view'
+
+    fake.country()
+    # 'Saint Kitts and Nevis'
+
+    fake.country_code(representation="alpha-2")
+    # 'AU'
+
+    fake.military_apo()
+    # 'PSC 4280, Box 6638'
+
+    fake.military_dpo()
+    # 'Unit 0439 Box 9077'
+
+    fake.military_ship()
+    # 'USS'
+
+    fake.military_state()
+    # 'AE'
+
+    fake.postalcode()
+    # '18280'
+
+    fake.postalcode_in_state(state_abbr=None)
+    # '83233'
+
+    fake.postalcode_plus4()
+    # '10416-7532'
+
+    fake.postcode()
+    # '87410'
+
+    fake.postcode_in_state(state_abbr=None)
+    # '49524'
+
+    fake.secondary_address()
+    # 'Suite 580'
+
+    fake.state()
+    # 'New York'
+
+    fake.state_abbr(include_territories=True)
+    # 'FL'
+
+    fake.street_address()
+    # '1539 Michael Street'
+
+    fake.street_name()
+    # 'Dominguez Ports'
+
+    fake.street_suffix()
+    # 'Glen'
+
+    fake.zipcode()
+    # '11597'
+
+    fake.zipcode_in_state(state_abbr=None)
+    # '68022'
+
+    fake.zipcode_plus4()
+    # '12001-1983'
diff --git a/docs/providers/automotive.rst b/docs/providers/automotive.rst
@@ -0,0 +1,7 @@
+automotive
+==========
+
+.. code-block:: python
+
+    fake.license_plate()
+    # 'PBT 123'
diff --git a/docs/providers/bank.rst b/docs/providers/bank.rst
@@ -0,0 +1,13 @@
+bank
+====
+
+.. code-block:: python
+
+    fake.bank_country()
+    # 'GB'
+
+    fake.bban()
+    # 'SCWM84334472954709'
+
+    fake.iban()
+    # 'GB11NJRO54900269409826'
diff --git a/docs/providers/barcode.rst b/docs/providers/barcode.rst
@@ -0,0 +1,19 @@
+barcode
+=======
+
+.. code-block:: python
+
+    fake.ean(length=13)
+    # '4003832285771'
+
+    fake.ean13(leading_zero=None)
+    # '9620020275212'
+
+    fake.ean8()
+    # '17726313'
+
+    fake.upc_a(upc_ae_mode=False, base=None, number_system_digit=None)
+    # '915865094906'
+
+    fake.upc_e(base=None, number_system_digit=None, safe_mode=True)
+    # '12356247'
diff --git a/docs/providers/base.rst b/docs/providers/base.rst
@@ -0,0 +1,67 @@
+base
+====
+
+.. code-block:: python
+
+    fake.bothify(text="## ??", letters="abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ")
+    # '70 SY'
+
+    fake.hexify(text="^^^^", upper=False)
+    # '5d05'
+
+    fake.language_code()
+    # 'kk'
+
+    fake.lexify(text="????", letters="abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ")
+    # 'ueZW'
+
+    fake.locale()
+    # 'fi_FI'
+
+    fake.numerify(text="###")
+    # '928'
+
+    fake.random_choices(elements=('a', 'b', 'c'), length=None)
+    # ['a', 'b']
+
+    fake.random_digit()
+    # 2
+
+    fake.random_digit_not_null()
+    # 7
+
+    fake.random_digit_not_null_or_empty()
+    # 1
+
+    fake.random_digit_or_empty()
+    # 0
+
+    fake.random_element(elements=('a', 'b', 'c'))
+    # 'a'
+
+    fake.random_elements(elements=('a', 'b', 'c'), length=None, unique=False)
+    # ['b']
+
+    fake.random_int(min=0, max=9999, step=1)
+    # 3825
+
+    fake.random_letter()
+    # 'A'
+
+    fake.random_letters(length=16)
+    # ['k', 'f', 'y', 'g', 'c', 'J', 'x', 'f', 'H', 'K', 'M', 'O', 'm', 'b', 'w', 'm']
+
+    fake.random_lowercase_letter()
+    # 'n'
+
+    fake.random_number(digits=None, fix_len=False)
+    # 6
+
+    fake.random_sample(elements=('a', 'b', 'c'), length=None)
+    # ['b']
+
+    fake.random_uppercase_letter()
+    # 'Z'
+
+    fake.randomize_nb_elements(number=10, le=False, ge=False, min=None, max=None)
+    # 11
diff --git a/docs/providers/color.rst b/docs/providers/color.rst
@@ -0,0 +1,25 @@
+color
+=====
+
+.. code-block:: python
+
+    fake.color(hue=None, luminosity=None, color_format="hex")
+    # '#c888f7'
+
+    fake.color_name()
+    # 'DarkGoldenRod'
+
+    fake.hex_color()
+    # '#95fcdf'
+
+    fake.rgb_color()
+    # '72,32,89'
+
+    fake.rgb_css_color()
+    # 'rgb(102,242,176)'
+
+    fake.safe_color_name()
+    # 'maroon'
+
+    fake.safe_hex_color()
+    # '#ccbb00'
diff --git a/docs/providers/company.rst b/docs/providers/company.rst
@@ -0,0 +1,16 @@
+company
+=======
+
+.. code-block:: python
+
+    fake.bs()
+    # 'implement revolutionary supply-chains'
+
+    fake.catch_phrase()
+    # 'Business-focused logistical attitude'
+
+    fake.company()
+    # 'Clay Group'
+
+    fake.company_suffix()
+    # 'LLC'
diff --git a/docs/providers/credit_card.rst b/docs/providers/credit_card.rst
@@ -0,0 +1,19 @@
+credit_card
+===========
+
+.. code-block:: python
+
+    fake.credit_card_expire(start="now", end="+10y", date_format="%m/%y")
+    # '09/25'
+
+    fake.credit_card_full(card_type=None)
+    # 'Discover\nDavid Taylor\n6011910416230682 07/24\nCVC: 814\n'
+
+    fake.credit_card_number(card_type=None)
+    # '4991269195116524'
+
+    fake.credit_card_provider(card_type=None)
+    # 'JCB 16 digit'
+
+    fake.credit_card_security_code(card_type=None)
+    # '4299'
diff --git a/docs/providers/currency.rst b/docs/providers/currency.rst
@@ -0,0 +1,22 @@
+currency
+========
+
+.. code-block:: python
+
+    fake.cryptocurrency()
+    # ('ZCL', 'Zclassic')
+
+    fake.cryptocurrency_code()
+    # 'ZCL'
+
+    fake.cryptocurrency_name()
+    # 'BlackCoin'
+
+    fake.currency()
+    # ('BMD', 'Bermudian dollar')
+
+    fake.currency_code()
+    # 'BMD'
+
+    fake.currency_name()
+    # 'Haitian gourde'
diff --git a/docs/providers/date_time.rst b/docs/providers/date_time.rst
@@ -0,0 +1,109 @@
+date_time
+=========
+
+.. code-block:: python
+
+    fake.am_pm()
+    # 'AM'
+
+    fake.century()
+    # 'II'
+
+    fake.date(pattern="%Y-%m-%d", end_datetime=None)
+    # '1992-05-08'
+
+    fake.date_between(start_date="-30y", end_date="today")
+    # datetime.date(1996, 3, 11)
+
+    fake.date_between_dates(date_start=None, date_end=None)
+    # datetime.date(2019, 12, 17)
+
+    fake.date_object(end_datetime=None)
+    # datetime.date(1970, 4, 28)
+
+    fake.date_of_birth(tzinfo=None, minimum_age=0, maximum_age=115)
+    # datetime.date(1974, 8, 27)
+
+    fake.date_this_century(before_today=True, after_today=False)
+    # datetime.date(2014, 3, 15)
+
+    fake.date_this_decade(before_today=True, after_today=False)
+    # datetime.date(2017, 7, 10)
+
+    fake.date_this_month(before_today=True, after_today=False)
+    # datetime.date(2019, 12, 5)
+
+    fake.date_this_year(before_today=True, after_today=False)
+    # datetime.date(2019, 3, 14)
+
+    fake.date_time(tzinfo=None, end_datetime=None)
+    # datetime.datetime(2009, 5, 31, 19, 30)
+
+    fake.date_time_ad(tzinfo=None, end_datetime=None, start_datetime=None)
+    # datetime.datetime(717, 8, 11, 11, 16, 48)
+
+    fake.date_time_between(start_date="-30y", end_date="now", tzinfo=None)
+    # datetime.datetime(2005, 6, 14, 13, 37, 29)
+
+    fake.date_time_between_dates(datetime_start=None, datetime_end=None, tzinfo=None)
+    # datetime.datetime(2019, 12, 17, 15, 40, 47)
+
+    fake.date_time_this_century(before_now=True, after_now=False, tzinfo=None)
+    # datetime.datetime(2001, 1, 5, 21, 12, 31)
+
+    fake.date_time_this_decade(before_now=True, after_now=False, tzinfo=None)
+    # datetime.datetime(2013, 11, 26, 18, 38, 11)
+
+    fake.date_time_this_month(before_now=True, after_now=False, tzinfo=None)
+    # datetime.datetime(2019, 12, 2, 23, 26, 7)
+
+    fake.date_time_this_year(before_now=True, after_now=False, tzinfo=None)
+    # datetime.datetime(2019, 10, 9, 20, 38, 9)
+
+    fake.day_of_month()
+    # '30'
+
+    fake.day_of_week()
+    # 'Thursday'
+
+    fake.future_date(end_date="+30d", tzinfo=None)
+    # datetime.date(2020, 1, 12)
+
+    fake.future_datetime(end_date="+30d", tzinfo=None)
+    # datetime.datetime(2020, 1, 3, 3, 48, 8)
+
+    fake.iso8601(tzinfo=None, end_datetime=None)
+    # '1985-06-24T10:08:04'
+
+    fake.month()
+    # '09'
+
+    fake.month_name()
+    # 'March'
+
+    fake.past_date(start_date="-30d", tzinfo=None)
+    # datetime.date(2019, 11, 29)
+
+    fake.past_datetime(start_date="-30d", tzinfo=None)
+    # datetime.datetime(2019, 12, 7, 0, 2, 27)
+
+    fake.time(pattern="%H:%M:%S", end_datetime=None)
+    # '06:57:15'
+
+    fake.time_delta(end_datetime=None)
+    # datetime.timedelta(0)
+
+    fake.time_object(end_datetime=None)
+    # datetime.time(14, 29, 53)
+
+    fake.time_series(start_date="-30d", end_date="now", precision=None, distrib=None, tzinfo=None)
+    # <generator object Provider.time_series at 0x7f3d78a484f8>
+
+    fake.timezone()
+    # 'Asia/Jerusalem'
+
+    fake.unix_time(end_datetime=None, start_datetime=None)
+    # 1437575659
+
+    fake.year()
+    # '1971'