Usage Guide
===========

This guide covers the main features and categories of data that Randum can generate.

Personal Information
--------------------

Generate personal data like names, emails, and phone numbers:

.. code-block:: python

   from randum import Randum
   rand = Randum()

   rand.name()              # Full name
   rand.first_name()        # First name
   rand.last_name()         # Last name
   rand.email()             # Email address
   rand.phone_number()      # Phone number
   rand.ssn()               # Social Security Number
   rand.job()               # Job title

Address Information
-------------------

Generate address-related data:

.. code-block:: python

   rand.address()           # Full address
   rand.city()              # City name
   rand.state()             # State name
   rand.country()           # Country name
   rand.zipcode()           # Zip code
   rand.latitude()          # Latitude coordinate
   rand.longitude()         # Longitude coordinate

Company Information
-------------------

Generate business-related data:

.. code-block:: python

   rand.company()           # Company name
   rand.company_email()     # Business email
   rand.catch_phrase()      # Marketing catch phrase
   rand.bs()                # Business jargon

Animals
-------

Generate animal-related data:

.. code-block:: python

   rand.animal()            # Random animal
   rand.mammal()            # Random mammal
   rand.bird()              # Random bird
   rand.fish()              # Random fish
   rand.dog_breed()         # Dog breed
   rand.cat_breed()         # Cat breed

Music
-----

Generate music-related data:

.. code-block:: python

   rand.music_genre()       # Music genre
   rand.instrument()        # Musical instrument
   rand.song_title()        # Song title
   rand.artist_name()       # Artist name
   rand.album_name()        # Album name
   rand.record_label()      # Record label

Sports
------

Generate sports-related data:

.. code-block:: python

   rand.sport()             # Random sport
   rand.team_sport()        # Team sport
   rand.olympic_sport()     # Olympic sport
   rand.team_name()         # Team name
   rand.athlete_name()      # Athlete name
   rand.sport_position()    # Sport position
   rand.jersey_number()     # Jersey number

Food
----

Generate food-related data:

.. code-block:: python

   rand.food()              # Random food item
   rand.fruit()             # Fruit
   rand.vegetable()         # Vegetable
   rand.cuisine()           # Cuisine type
   rand.dish()              # Dish name
   rand.dessert()           # Dessert
   rand.beverage()          # Beverage

Books & Literature
------------------

Generate book-related data:

.. code-block:: python

   rand.book_title()        # Book title
   rand.author_name()       # Author name
   rand.literary_genre()    # Literary genre
   rand.publisher()         # Publisher
   rand.isbn()              # ISBN number

Vehicles
--------

Generate vehicle-related data:

.. code-block:: python

   rand.vehicle_make_model()  # Car make and model
   rand.vehicle_year()        # Vehicle year
   rand.license_plate()       # License plate
   rand.vin()                 # VIN number
   rand.fuel_type()           # Fuel type

Weather
-------

Generate weather-related data:

.. code-block:: python

   rand.weather()           # Weather condition
   rand.temperature()       # Temperature
   rand.wind_speed()        # Wind speed
   rand.humidity()          # Humidity percentage
   rand.season()            # Season

Education
---------

Generate education-related data:

.. code-block:: python

   rand.degree()            # Degree name
   rand.university_name()   # University name
   rand.course_name()       # Course name
   rand.gpa()               # GPA
   rand.letter_grade()      # Letter grade
   rand.academic_subject()  # Academic subject

Internet & Technology
---------------------

Generate internet-related data:

.. code-block:: python

   rand.username()          # Username
   rand.password()          # Password
   rand.url()               # URL
   rand.ipv4()              # IPv4 address
   rand.ipv6()              # IPv6 address
   rand.mac_address()       # MAC address

Financial
---------

Generate financial data:

.. code-block:: python

   rand.credit_card_number()    # Credit card number
   rand.credit_card_provider()  # Card provider
   rand.currency_code()         # Currency code
   rand.iban()                  # IBAN number

Dates & Times
-------------

Generate date and time data:

.. code-block:: python

   rand.date()              # Random date
   rand.past_date()         # Past date
   rand.future_date()       # Future date
   rand.time()              # Random time
   rand.unix_time()         # Unix timestamp

Text & Lorem Ipsum
------------------

Generate random text:

.. code-block:: python

   rand.word()              # Single word
   rand.sentence()          # Sentence
   rand.paragraph()         # Paragraph
   rand.text()              # Random text

Colors
------

Generate color data:

.. code-block:: python

   rand.color_name()        # Color name
   rand.hex_color()         # Hex color code
   rand.rgb_color()         # RGB color