faculty¶

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

Returns random faculty objects.

Parameters:

repeat (int) – The number of random faculty objects 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 faculty:

$ naija faculty
{'faculty_name': 'Medicine and Dentistry', 'departments': ['Bachelor of Medicine and Bachelor of Surgery', 'Dentistry']}

To return 3 random faculty objects:

$ naija faculty --repeat 3
{'faculty_name': 'Basic Medical Sciences', 'departments': ['Human Anatomy', 'Physiology']}
{'faculty_name': 'Medicine and Dentistry', 'departments': ['Bachelor of Medicine and Bachelor of Surgery', 'Dentistry']}
{'faculty_name': 'Computing', 'departments': ['Cybersecurity', 'Software Engineering', 'Data Science', 'Information and Communications Technology', 'Information Technology', 'Information System', 'Computer Science']}

To return 30 random faculty objects and save them to a specified format:

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

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

Returns random faculty names.

Parameters:

repeat (int) – The number of random faculty names 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 faculty name:

$ naija faculty_name
Allied Health Sciences

To return 3 random faculty names:

$ naija faculty_name --repeat 3
Law
Allied Health Sciences
Medicine and Dentistry

To return 30 random faculty names and save them to a specified format:

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

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

Returns random department names.

Parameters:

repeat (int) – The number of random department names to return. Must be a positive integer. Defaults to 1.
faculty (str) – The specific faculty name to return departments from. Defaults to None.
output (str) – The format of the output file if provided.

Raises:

ValueError – If the given faculty name is invalid.

Note

Output options: csv, json, text

Examples

To return a single department name:

$ naija department_name
Computer Science

To return 3 random department names:

$ naija department_name --repeat 3
Physiology
Logistics and Supply Chain Management
Health Information Management

To return a single department by faculty name:

$ naija department_name --faculty 'Basic Medical Sciences'
Human Anatomy

To return 3 random departments by faculty name:

$ naija department_name --faculty 'computing' --repeat 3
Computer Science
Information and Communications Technology
Data Science

To return 30 random department names and save them to a specified format:

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