school¶

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

Return random school objects.

Parameters:

repeat (int) – The number of random school objects to return. Must be a positive integer. Defaults to 1.
ownership (str) – Filter schools by ownership type.
state (str) – Filter schools by state.
school_type (str) – Filter schools by type.
output (str) – The format of the output file if provided.

Note

Ownership options: federal, state, private
School type options: university, polytechnic, college
State options: 36 states in Nigeria + FCT
Output options: csv, json, text

Examples

To return a single random school object:

$ naija school
{'name': 'Fidei Polytechnic', 'acronym': 'FIDEIPOLY', 'state': 'Benue', 'type': 'Polytechnic', 'ownership': 'Private'}

To return 3 random school objects:

$ naija school --repeat 3
{'name': 'Federal Polytechnic Bali', 'acronym': 'FEDPOLYBALI', 'state': 'Taraba', 'type': 'Polytechnic', 'ownership': 'Federal'}
{'name': 'Federal University of Petroleum Resources, Effurun', 'acronym': 'FUPRE', 'state': 'Delta', 'type': 'University', 'ownership': 'Federal'}
{'name': 'Nnamdi Azikiwe University', 'acronym': 'UNIZIK', 'state': 'Anambra', 'type': 'University', 'ownership': 'Federal'}

To return a random school object filtered by ownership:

$ naija school --ownership private
{'name': 'Ajayi Crowther University', 'acronym': 'ACU', 'state': 'Oyo', 'type': 'University', 'ownership': 'Private'}

To return a random school object filtered by school type:

$ naija school --school_type college
{'name': 'Federal College of Education, Zaria', 'acronym': 'FCEZARIA', 'state': 'Kaduna', 'type': 'College', 'ownership': 'Federal'}

To return a random school object from a specific state in Nigeria:

$ naija school --state abuja
{'name': 'University of Abuja', 'acronym': 'UNIABUJA', 'state': 'Abuja', 'type': 'University', 'ownership': 'Federal'}

To return 3 random school objects filtered by ownership, school type and state:

$ naija school --ownership private --state ogun --school_type university -r 3
{'name': 'Babcock University', 'acronym': 'BU', 'state': 'Ogun', 'type': 'University', 'ownership': 'Private'}
{'name': 'Covenant University', 'acronym': 'CU', 'state': 'Ogun', 'type': 'University', 'ownership': 'Private'}
{'name': 'Bells University of Technology', 'acronym': 'BELLSTECH', 'state': 'Ogun', 'type': 'University', 'ownership': 'Private'}

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

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

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

Return random school names.

Parameters:

repeat (int) – The number of random school names to return. Must be a positive integer. Defaults to 1.
acronym (bool) – Whether to return the school’s acronym instead of the full name.
ownership (str) – Filter schools by ownership type.
state (str) – Filter schools by state.
school_type (str) – Filter schools by type.
output (str) – The format of the output file if provided.

Note

Ownership options: federal, state, private
School type options: university, polytechnic, college
State options: 36 states in Nigeria + FCT
Output options: csv, json, text

Examples

To return a single random school name:

$ naija school_name
Federal College of Education, Abeokuta

To return a school acronym instead of the full name:

$ naija school_name --acronym
UNN

To return 3 random school names:

$ naija school_name -r 3
Federal College of Education (Technical), Gombe
Federal University of Technology, Akure
Best Legacy College of Education

To return a random school name filtered by ownership:

$ naija school_name --ownership private
Bells University of Technology

To return a random school name filtered by school type:

$ naija school_name --school_type college
Abia State College of Education (Technical), Arochukwu

To return a random school name from a specific state in Nigeria:

$ naija school_name --state "akwa ibom"
University of Uyo

To return 3 random private universities in Ogun:

$ naija school_name --school_type university --ownership private --state ogun --repeat 3
Babcock University
Bells University of Technology
Covenant University

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

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