Welcome to Randum's documentation!
===================================

Randum is a powerful Random Universal Data Generator for Python. It provides an easy-to-use interface for generating realistic fake data across multiple categories including personal information, addresses, companies, internet data, dates, and much more.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   installation
   quickstart
   usage
   api
   contributing

Features
--------

* **Personal Information**: Names, emails, phone numbers, SSNs, job titles
* **Address Information**: Full addresses, cities, states, countries, coordinates
* **Company Information**: Company names, business emails, catch phrases
* **Internet & Technology**: Usernames, passwords, IP addresses, URLs, domains
* **Dates & Times**: Random dates, past and future dates, timestamps
* **Financial**: Credit card numbers, currency codes, IBAN numbers
* **Animals**: Mammals, birds, reptiles, fish, dog/cat breeds
* **Music**: Genres, instruments, song titles, artist names, albums
* **Sports**: All major sports, team names, athlete names, venues, leagues
* **Food**: Fruits, vegetables, meats, cuisines, dishes, recipes
* **Books & Literature**: Book titles, authors, genres, publishers
* **Vehicles & Automotive**: Car makes/models, license plates, VIN numbers
* **Weather & Climate**: Weather conditions, temperature, wind, humidity
* **Education**: Degrees, universities, courses, GPAs, academic subjects

Quick Example
-------------

.. code-block:: python

   from randum import Randum

   rand = Randum()
   
   print(rand.name())          # 'John Doe'
   print(rand.email())         # 'john.doe@example.com'
   print(rand.address())       # '123 Main St, Springfield, IL 62701'
   print(rand.animal())        # 'Lion'
   print(rand.music_genre())   # 'Rock'
   print(rand.sport())         # 'Basketball'

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`