.. ref-communityproviders:

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      |                                  |
+---------------+---------------------------+----------------------------------+
| Datasets      | Build providers based     | `faker-datasets`_                |
|               | on datasets               |                                  |
+---------------+---------------------------+----------------------------------+
| Education     | Public school name and    | `faker_education`_               |
|               | info for testing purposes |                                  |
+---------------+---------------------------+----------------------------------+
| Faker File    | Generate files with fake  | `faker-file`_                    |
|               | content                   |                                  |
+---------------+---------------------------+----------------------------------+
| Geoscience    | Earth sciences-related    | `faker_geoscience`_              |
|               | fake-random data          |                                  |
|               | generators.               |                                  |
+---------------+---------------------------+----------------------------------+
| Market Data   | Fake market data          |                                  |
|               | identifiers (SEDOL, CUSIP,| `faker_marketdata`_              |
|               | ISIN, etc.)               |                                  |
|               |                           |                                  |
+---------------+---------------------------+----------------------------------+
| Microservice  | Fake microservice names   | `faker_microservice`_            |
+---------------+---------------------------+----------------------------------+
| Music         | Music genres, subgenres,  | `faker_music`_                   |
|               | and instruments.          |                                  |
+---------------+---------------------------+----------------------------------+
| Posts         | Fake posts in markdown    | `mdgen`_                         |
|               | format                    |                                  |
+---------------+---------------------------+----------------------------------+
| PySpark       | Fake PySpark DataFrame    | `faker_pyspark`_                 |
|               | and Schema generator      |                                  |
+---------------+---------------------------+----------------------------------+
| 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      | Small wrapper around      | `optional_faker`_                |
|               | faker, to make values     |                                  |
|               | optional!                 |                                  |
+---------------+---------------------------+----------------------------------+
| Presidio      | Create synthetic datasets | `presidio-evaluator`_            |
| Sentence      | for training Named Entity |                                  |
| Faker         | Recognition models        |                                  |
|               | using Faker.              |                                  |
+---------------+---------------------------+----------------------------------+

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

In order to be included, your provider must satisfy these requirements:

* it must have tests.
* it must be published on PyPI.
* it must have an `OSI-Approved`_ License.
* it must not duplicate any functionality already present in ``Faker``.
* it must not contain any profanity, either in code or in documentation.
* it must not contain any malicious nor any kind of telemetry code.

.. _repo: https://github.com/joke2k/faker/
.. _OSI-Approved: https://opensource.org/licenses/alphabetical
.. _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-datasets: https://pypi.org/project/faker-datasets/
.. _faker_education: https://pypi.org/project/faker_education/
.. _faker-file: https://pypi.org/project/faker-file/
.. _faker_geoscience: https://pypi.org/project/faker-geoscience/
.. _faker_marketdata: https://pypi.org/project/faker-marketdata/
.. _faker_microservice: https://pypi.org/project/faker-microservice/
.. _faker_music: https://pypi.org/project/faker_music/
.. _mdgen: https://pypi.org/project/mdgen/
.. _faker_pyspark: https://pypi.org/project/faker-pyspark/
.. _faker_vehicle: https://pypi.org/project/faker-vehicle/
.. _faker_web: https://pypi.org/project/faker_web/
.. _faker_wifi_essid: https://pypi.org/project/faker-wifi-essid/
.. _optional_faker: https://pypi.org/project/optional_faker
.. _presidio-evaluator: https://pypi.org/project/presidio-evaluator
