Skip to content

Commit

Permalink
Add a new Education Provider to community providers list (#1678)
Browse files Browse the repository at this point in the history
* Add a new Education Provider

I created a new education provider to populate public school information from schools in the United States. I may add additional information later but for now I needed this so I figured I'd publish so other's could use it too.

* lint

Co-authored-by: Flavio Curella <89607+fcurella@users.noreply.github.com>
  • Loading branch information
matthttam8411 and fcurella authored Jul 11, 2022
1 parent 3859512 commit 8b1e8b8
Showing 1 changed file with 42 additions and 38 deletions.
80 changes: 42 additions & 38 deletions docs/communityproviders.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,44 +5,47 @@ Community Providers

Here's a list of Providers written by the community:

+---------------+--------------------------+----------------------------------+
| Provider name | Description | URL |
+===============+==========================+==================================+
| Airtravel | Airport names, airport | `faker_airtravel`_ |
| | codes, and flights. | |
+---------------+--------------------------+----------------------------------+
| Biology | Fake data from biology | `faker_biology`_ |
| | and life-science domains | |
| | for testing purposes | |
+---------------+--------------------------+----------------------------------+
| Credit Score | Fake credit score data | `faker_credit_score`_ |
| | for testing purposes | |
+---------------+--------------------------+----------------------------------+
| Geoscience | Earth sciences-related | `faker_geoscience`_ |
| | fake-random data | |
| | generators. | |
+---------------+--------------------------+----------------------------------+
| Microservice | Fake microservice names | `faker_microservice`_ |
+---------------+--------------------------+----------------------------------+
| Music | Music genres, subgenres, | `faker_music`_ |
| | and instruments. | |
+---------------+--------------------------+----------------------------------+
| Posts | Fake posts in markdown | `mdgen`_ |
| | format | |
+---------------+--------------------------+----------------------------------+
| Vehicle | Fake vehicle information | `faker_vehicle`_ |
| | includes Year Make Model | |
+---------------+--------------------------+----------------------------------+
| WebProvider | Web-related data such as | `faker_web`_ |
| | mime-type and web server | |
| | versions. | |
+---------------+--------------------------+----------------------------------+
| Wi-Fi ESSID | Fake Wi-Fi ESSIDs. | `faker_wifi_essid`_ |
+---------------+--------------------------+----------------------------------+
| Optional | Wrap over other | `faker_optional`_ |
| | providers to return | |
| | their value or `None`. | |
+---------------+--------------------------+----------------------------------+
+---------------+---------------------------+----------------------------------+
| Provider name | Description | URL |
+===============+===========================+==================================+
| Airtravel | Airport names, airport | `faker_airtravel`_ |
| | codes, and flights. | |
+---------------+---------------------------+----------------------------------+
| Biology | Fake data from biology | `faker_biology`_ |
| | and life-science domains | |
| | for testing purposes | |
+---------------+---------------------------+----------------------------------+
| Credit Score | Fake credit score data | `faker_credit_score`_ |
| | for testing purposes | |
+---------------+---------------------------+----------------------------------+
| Education | Public school name and | `faker_education`_ |
| | info for testing purposes | |
+---------------+---------------------------+----------------------------------+
| Geoscience | Earth sciences-related | `faker_geoscience`_ |
| | fake-random data | |
| | generators. | |
+---------------+---------------------------+----------------------------------+
| Microservice | Fake microservice names | `faker_microservice`_ |
+---------------+---------------------------+----------------------------------+
| Music | Music genres, subgenres, | `faker_music`_ |
| | and instruments. | |
+---------------+---------------------------+----------------------------------+
| Posts | Fake posts in markdown | `mdgen`_ |
| | format | |
+---------------+---------------------------+----------------------------------+
| Vehicle | Fake vehicle information | `faker_vehicle`_ |
| | includes Year Make Model | |
+---------------+---------------------------+----------------------------------+
| WebProvider | Web-related data such as | `faker_web`_ |
| | mime-type and web server | |
| | versions. | |
+---------------+---------------------------+----------------------------------+
| Wi-Fi ESSID | Fake Wi-Fi ESSIDs. | `faker_wifi_essid`_ |
+---------------+---------------------------+----------------------------------+
| Optional | Wrap over other | `faker_optional`_ |
| | providers to return | |
| | their value or `None`. | |
+---------------+---------------------------+----------------------------------+

If you want to add your own provider to this list, please submit a Pull Request to our `repo`_.

Expand All @@ -60,6 +63,7 @@ In order to be included, your provider must satisfy these requirement:
.. _faker_airtravel: https://pypi.org/project/faker_airtravel/
.. _faker_biology: https://pypi.org/project/faker_biology/
.. _faker_credit_score: https://pypi.org/project/faker-credit-score/
.. _faker_education: https://pypi.org/project/faker_education/
.. _faker_geoscience: https://pypi.org/project/faker-geoscience/
.. _faker_microservice: https://pypi.org/project/faker-microservice/
.. _faker_music: https://pypi.org/project/faker_music/
Expand Down

0 comments on commit 8b1e8b8

Please sign in to comment.