Faker-Edu

1.1.0 · active · verified Fri Apr 17

Faker-Edu is a provider for the Faker library, extending its capabilities to generate fake information related to educational institutions and academics. It's currently at version 1.1.0 and has a moderate release cadence, focusing on adding new generators. It's designed to be used in conjunction with the main Faker library for data generation in testing and development.

Common errors

```
AttributeError: 'Generator' object has no attribute 'high_school'
```
cause The faker-edu provider has not been added to the Faker instance.

fix Add the provider using `fake.add_provider(EduProvider)` after initializing your `Faker` object.
```
ModuleNotFoundError: No module named 'faker_edu'
```
cause The `faker-edu` library is not installed in your current Python environment.

fix Install the package: `pip install faker-edu`.
```
ModuleNotFoundError: No module named 'faker'
```
cause The base `faker` library, which `faker-edu` depends on, is not installed.

fix Install the base Faker library: `pip install faker`.

Warnings

gotcha After installing 'faker-edu', you must explicitly add its 'Provider' class to your Faker instance using `fake.add_provider()`.
Fix: Always include `fake.add_provider(EduProvider)` after initializing `Faker()` and importing `EduProvider`.
gotcha Ensure you have the base 'faker' library installed. 'faker-edu' is a provider and depends on 'faker' to function.
Fix: Run `pip install faker` if you haven't already, in addition to `pip install faker-edu`.

Install

pip install faker-edu Install Faker-Edu

Imports

Provider
wrong:
```
from faker_edu.provider import EduProvider
```
correct:
```
from faker_edu import Provider as EduProvider
```
The main provider class is directly accessible from the top-level package and should be aliased for clarity when added to Faker.
Faker
```
from faker import Faker
```
The base Faker class is required to use faker-edu providers.

Quickstart

This quickstart demonstrates how to initialize the Faker library, add the Faker-Edu provider, and then generate various types of educational data such as high school names, college names, academic disciplines, facilities, and sports.

from faker import Faker
from faker_edu import Provider as EduProvider

# Initialize Faker
fake = Faker()

# Add the Faker-Edu provider
fake.add_provider(EduProvider)

# Generate fake educational data
print(f"High School: {fake.high_school()}")
print(f"College: {fake.college()}")
print(f"Academic Discipline: {fake.academic_discipline()}")
print(f"Facility: {fake.facility()}")
print(f"Sport: {fake.sport()}")

view raw JSON →