marital_status

fakernaija.commands.marital_status(*args: t.Any, **kwargs: t.Any) → t.Any

Returns random marital statuses.

Parameters:

  • repeat (int) – The number of random marital statuses to return. Must be a positive integer. Defaults to 1.

  • output (str) – The format of the output file if provided.

Note

  • Output options: csv, json, text

Examples

To return a single random marital status:

$ naija marital_status
Widowed

To return 3 random marital statuses:

$ naija marital_status --repeat 3
Married
Annulled
Engaged

To return 30 random marital statuses and save them to a specified format:

$ naija marital_status --repeat 30 --output text
Generated data saved to /path/to/directory/filename.ext