Wetterdienst - Open weather data for humans
###########################################

.. |pic1| image:: https://raw.githubusercontent.com/earthobservations/wetterdienst/main/docs/img/german_weather_stations.png
    :alt: German weather stations managed by Deutscher Wetterdienst
    :width: 32%

.. |pic2| image:: https://raw.githubusercontent.com/earthobservations/wetterdienst/main/docs/img/temperature_ts.png
    :alt: temperature timeseries of Hohenpeissenberg/Germany
    :width: 32%

.. |pic3| image:: https://raw.githubusercontent.com/earthobservations/wetterdienst/main/docs/img/hohenpeissenberg_warming_stripes.png
    :alt: warming stripes of Hohenpeissenberg/Germany
    :width: 32%

|pic1| |pic2| |pic3|

..

    **"What do we want? Climate Justice! When do we want it? Now!" - FFF**

..

    **WARNING**

    This library is a work in progress!

    Breaking changes should be expected until a 1.0 release, so version pinning is recommended.

**CI**

.. image:: https://github.com/earthobservations/wetterdienst/actions/workflows/tests.yml/badge.svg?branch=main
   :target: https://github.com/earthobservations/wetterdienst/actions?workflow=Tests
   :alt: CI: Overall outcome
.. image:: https://readthedocs.org/projects/wetterdienst/badge/?version=latest
   :target: https://wetterdienst.readthedocs.io/en/latest/?badge=latest
   :alt: Documentation status
.. image:: https://codecov.io/gh/earthobservations/wetterdienst/branch/main/graph/badge.svg
   :target: https://codecov.io/gh/earthobservations/wetterdienst
   :alt: CI: Code coverage

**Meta**

.. image:: https://img.shields.io/pypi/v/wetterdienst.svg
   :target: https://pypi.org/project/wetterdienst/
   :alt: PyPI version
.. image:: https://img.shields.io/conda/vn/conda-forge/wetterdienst.svg
   :target: https://anaconda.org/conda-forge/wetterdienst
   :alt: Conda version
.. image:: https://img.shields.io/github/license/earthobservations/wetterdienst
   :target: https://github.com/earthobservations/wetterdienst/blob/main/LICENSE
   :alt: Project license
.. image:: https://img.shields.io/pypi/status/wetterdienst.svg
   :target: https://pypi.python.org/pypi/wetterdienst/
   :alt: Project status (alpha, beta, stable)
.. image:: https://img.shields.io/pypi/pyversions/wetterdienst.svg
   :target: https://pypi.python.org/pypi/wetterdienst/
   :alt: Python version compatibility

**Downloads**

.. image:: https://static.pepy.tech/personalized-badge/wetterdienst?period=month&units=international_system&left_color=grey&right_color=blue&left_text=PyPI%20downloads/month
   :target: https://pepy.tech/project/wetterdienst
   :alt: PyPI downloads
.. image:: https://img.shields.io/conda/dn/conda-forge/wetterdienst.svg?label=Conda%20downloads
   :target: https://anaconda.org/conda-forge/wetterdienst
   :alt: Conda downloads

**Citation**

.. image:: https://zenodo.org/badge/160953150.svg
   :target: https://zenodo.org/badge/latestdoi/160953150
   :alt: Citation reference

.. overview_start_marker

Introduction
############

Overview
********

Welcome to Wetterdienst, your friendly weather service library for Python.

We are a group of like-minded people trying to make access to weather data in
Python feel like a warm summer breeze, similar to other projects like
rdwd_ for the R language, which originally drew our interest in this project.
Our long-term goal is to provide access to multiple weather services as well as other
related agencies such as river measurements. With ``wetterdienst`` we try to use modern
Python technologies all over the place. The library is based on polars_ (we <3 pandas_, it is still part of some
IO processes) across the board, uses Poetry_ for package administration and GitHub Actions for all things CI.
Our users are an important part of the development as we are not currently using the
data we are providing and only implement what we think would be the best. Therefore
contributions and feedback whether it be data related or library related are very
welcome! Just hand in a PR or Issue if you think we should include a new feature or data
source.

.. _rdwd: https://github.com/brry/rdwd
.. _polars: https://www.pola.rs/
.. _pandas: https://pandas.pydata.org/
.. _Poetry: https://python-poetry.org/

Data
****

.. _data: https://wetterdienst.readthedocs.io/en/latest/data/index.html
.. _coverage: https://wetterdienst.readthedocs.io/en/improve-documentation/data/coverage.html
.. _map: https://bookdown.org/brry/rdwd/interactive-map.html
.. _table: https://bookdown.org/brry/rdwd/available-datasets.html

For an overview of the data we have currently made available and under which
license it is published take a look at the data_ section. Detailed information
on datasets and parameters is given at the coverage_ subsection. Licenses and
usage requirements may differ for each provider so check this out before including
the data in your project to be sure that you fulfill copyright requirements!

Features
********

- APIs for stations and values
- Get stations nearby a selected location
- Define your request by arguments such as `parameter`, `period`, `resolution`,
  `start date`, `end date`
- Define general settings in Settings context
- Command line interface
- Web-API via FastAPI, hosted on `wetterdienst.eobs.org <https://wetterdienst.eobs.org>`_
- Rich UI features like `explorer <https://wetterdienst.streamlit.app>`_, `stripes <https://stripes.streamlit.app>`_
- Run SQL queries on the results
- Export results to databases and other data sinks
- Public Docker image
- Interpolation and Summary of station values

Setup
*****

Native
======

Via PyPi (standard):

.. code-block:: bash

    pip install wetterdienst

Via Github (most recent):

.. code-block:: bash

    pip install git+https://github.com/earthobservations/wetterdienst

There are some extras available for ``wetterdienst``. Use them like:

.. code-block:: bash

    pip install wetterdienst[sql]

- docs: Install the Sphinx documentation generator.
- ipython: Install iPython stack.
- export: Install openpyxl for Excel export and pyarrow for writing files in Feather- and Parquet-format.
- sql: Install DuckDB for querying data using SQL.
- duckdb: Install support for DuckDB.
- influxdb: Install support for InfluxDB.
- cratedb: Install support for CrateDB.
- mysql: Install support for MySQL.
- postgresql: Install support for PostgreSQL.
- interpolation: Install support for station interpolation.

In order to check the installation, invoke:

.. code-block:: bash

    wetterdienst --help

.. _run-in-docker:

Docker
======

Docker images for each stable release will get pushed to GitHub Container Registry.

``wetterdienst`` serves a full environment, including *all* of the optional dependencies of Wetterdienst.

Pull the Docker image:

.. code-block:: bash

    docker pull ghcr.io/earthobservations/wetterdienst

Library
-------

Use the latest stable version of ``wetterdienst``:

.. code-block:: bash

    $ docker run -ti ghcr.io/earthobservations/wetterdienst
    Python 3.8.5 (default, Sep 10 2020, 16:58:22)
    [GCC 8.3.0] on linux

.. code-block:: python

    import wetterdienst
    wetterdienst.__version__

Command line script
-------------------

The ``wetterdienst`` command is also available:

.. code-block:: bash

    # Make an alias to use it conveniently from your shell.
    alias wetterdienst='docker run -ti ghcr.io/earthobservations/wetterdienst wetterdienst'

    wetterdienst --help
    wetterdienst --version
    wetterdienst info

Raspberry Pi / LINUX ARM
========================

Running wetterdienst on Raspberry Pi, you need to install **numpy**
and **lxml** prior to installing wetterdienst by running the following
lines:

.. code-block:: bash

    # not all installations may be required to get lxml running
    sudo apt-get install gfortran
    sudo apt-get install libopenblas-base
    sudo apt-get install libopenblas-dev
    sudo apt-get install libatlas-base-dev
    sudo apt-get install python3-lxml

Additionally expanding the Swap to 2048 mb may be required and can be done via swap-file:

.. code-block:: bash

    sudo nano /etc/dphys-swapfile

Thanks `chr-sto`_ for reporting back to us!

.. _chr-sto: https://github.com/chr-sto

Example
*******

**Task: Get historical climate summary for two German stations between 1990 and 2020**

Library
=======

.. code-block:: python

    >>> import polars as pl
    >>> _ = pl.Config.set_tbl_hide_dataframe_shape(True)
    >>> from wetterdienst import Settings
    >>> from wetterdienst.provider.dwd.observation import DwdObservationRequest
    >>> settings = Settings( # default
    ...     ts_shape="long",  # tidy data
    ...     ts_humanize=True,  # humanized parameters
    ...     ts_si_units=True  # convert values to SI units
    ... )
    >>> request = DwdObservationRequest(
    ...    parameter="climate_summary",
    ...    resolution="daily",
    ...    start_date="1990-01-01",  # if not given timezone defaulted to UTC
    ...    end_date="2020-01-01",  # if not given timezone defaulted to UTC
    ...    settings=settings
    ... ).filter_by_station_id(station_id=(1048, 4411))
    >>> stations = request.df
    >>> stations.head()
    ┌────────────┬──────────────┬──────────────┬──────────┬───────────┬────────┬─────────────┬─────────┐
    │ station_id ┆ start_date   ┆ end_date     ┆ latitude ┆ longitude ┆ height ┆ name        ┆ state   │
    │ ---        ┆ ---          ┆ ---          ┆ ---      ┆ ---       ┆ ---    ┆ ---         ┆ ---     │
    │ str        ┆ datetime[μs, ┆ datetime[μs, ┆ f64      ┆ f64       ┆ f64    ┆ str         ┆ str     │
    │            ┆ UTC]         ┆ UTC]         ┆          ┆           ┆        ┆             ┆         │
    ╞════════════╪══════════════╪══════════════╪══════════╪═══════════╪════════╪═════════════╪═════════╡
    │ 01048      ┆ 1934-01-01   ┆ ...          ┆ 51.1278  ┆ 13.7543   ┆ 228.0  ┆ Dresden-Klo ┆ Sachsen │
    │            ┆ 00:00:00 UTC ┆ 00:00:00 UTC ┆          ┆           ┆        ┆ tzsche      ┆         │
    │ 04411      ┆ 1979-12-01   ┆ ...          ┆ 49.9195  ┆ 8.9672    ┆ 155.0  ┆ Schaafheim- ┆ Hessen  │
    │            ┆ 00:00:00 UTC ┆ 00:00:00 UTC ┆          ┆           ┆        ┆ Schlierbach ┆         │
    └────────────┴──────────────┴──────────────┴──────────┴───────────┴────────┴─────────────┴─────────┘
    >>> values = request.values.all().df
    >>> values.head()
    ┌────────────┬─────────────────┬───────────────────┬─────────────────────────┬───────┬─────────┐
    │ station_id ┆ dataset         ┆ parameter         ┆ date                    ┆ value ┆ quality │
    │ ---        ┆ ---             ┆ ---               ┆ ---                     ┆ ---   ┆ ---     │
    │ str        ┆ str             ┆ str               ┆ datetime[μs, UTC]       ┆ f64   ┆ f64     │
    ╞════════════╪═════════════════╪═══════════════════╪═════════════════════════╪═══════╪═════════╡
    │ 01048      ┆ climate_summary ┆ cloud_cover_total ┆ 1990-01-01 00:00:00 UTC ┆ 100.0 ┆ 10.0    │
    │ 01048      ┆ climate_summary ┆ cloud_cover_total ┆ 1990-01-02 00:00:00 UTC ┆ 100.0 ┆ 10.0    │
    │ 01048      ┆ climate_summary ┆ cloud_cover_total ┆ 1990-01-03 00:00:00 UTC ┆ 91.25 ┆ 10.0    │
    │ 01048      ┆ climate_summary ┆ cloud_cover_total ┆ 1990-01-04 00:00:00 UTC ┆ 28.75 ┆ 10.0    │
    │ 01048      ┆ climate_summary ┆ cloud_cover_total ┆ 1990-01-05 00:00:00 UTC ┆ 91.25 ┆ 10.0    │
    └────────────┴─────────────────┴───────────────────┴─────────────────────────┴───────┴─────────┘

.. code-block:: python

    values.to_pandas() # to get a pandas DataFrame and e.g. create some matplotlib plots

Client
======

.. code-block:: bash

    # Get list of all stations for daily climate summary data in JSON format
    wetterdienst stations --provider=dwd --network=observation --parameter=kl --resolution=daily --all

    # Get daily climate summary data for specific stations
    wetterdienst values --provider=dwd --network=observation --station=1048,4411 --parameter=kl --resolution=daily

Further examples (code samples) can be found in the examples_ folder.

.. _examples: https://github.com/earthobservations/wetterdienst/tree/main/examples

.. overview_end_marker

Acknowledgements
****************

We want to acknowledge all environmental agencies which provide their data open and free
of charge first and foremost for the sake of endless research possibilities.

We want to acknowledge Jetbrains_ and the `Jetbrains OSS Team`_ for providing us with
licenses for Pycharm Pro, which we are using for the development.

We want to acknowledge all contributors for being part of the improvements to this
library that make it better and better every day.

.. _Jetbrains: https://www.jetbrains.com/
.. _Jetbrains OSS Team: https://github.com/JetBrains

Important Links
***************

- Restapi: https://wetterdienst.eobs.org/
- Explorer: https://wetterdienst.streamlit.app/
- Stripes: https://stripes.streamlit.app/
- Documentation: https://wetterdienst.readthedocs.io/

  - Usage: https://wetterdienst.readthedocs.io/en/latest/usage/
  - Contribution: https://wetterdienst.readthedocs.io/en/latest/contribution/
  - Changelog: https://wetterdienst.readthedocs.io/en/latest/changelog.html

- Examples (runnable scripts): https://github.com/earthobservations/wetterdienst/tree/main/examples
- Benchmarks: https://github.com/earthobservations/wetterdienst/tree/main/benchmarks

.. _Polars DataFrame: https://pola-rs.github.io/polars/py-polars/html/reference/dataframe/


# scoops

[![ci](https://github.com/rasa/scoops/actions/workflows/excavator.yml/badge.svg)](https://github.com/rasa/scoops/actions/workflows/excavator.yml)
[![license](https://img.shields.io/github/license/rasa/scoops.svg?style=flat-square)](https://github.com/rasa/scoops/blob/master/LICENSE)
[![repo size](https://img.shields.io/github/repo-size/rasa/scoops.svg?style=flat-square)](https://github.com/rasa/scoops)
[![awesome](https://awesome.re/mentioned-badge-flat.svg)](https://github.com/scoopinstaller/awesome/blob/master/README.md)

Custom scoop packages.

wfc is the only app in this repository that requires elevated (administrator) privileges to install.

## Usage

[Scoop](http://scoop.sh/) is apt-get (or homebrew) for Windows.

To add this bucket to scoop, type:

```sh
scoop bucket add rasa https://github.com/rasa/scoops.git
```

You can also install apps without adding the bucket. For example:

```sh
scoop install https://raw.githubusercontent.com/rasa/scoops/master/bucket/android-messages.json
```

## Apps

|Name|Version|Description|License|
|----|-------|-----------|-------|
|[android-messages]( "")|5.3.4|||
|[api-monitor](http://www.rohitab.com/apimonitor "http://www.rohitab.com/apimonitor")|[2r13](http://www.rohitab.com/apimonitor "http://www.rohitab.com/apimonitor")|Monitor API calls|[Freeware](https://en.wikipedia.org/wiki/Freeware "https://en.wikipedia.org/wiki/Freeware")|
|[attr](https://github.com/rasa/attr "https://github.com/rasa/attr")|[1.6](https://github.com/rasa/attr "https://github.com/rasa/attr")|Display and set attributes on files and directories|[MIT](https://spdx.org/licenses/MIT "https://spdx.org/licenses/MIT")|
|[audacity-ffmpeg-plugin](https://lame.buanzo.org/ "https://lame.buanzo.org/")|[2.2.2](https://lame.buanzo.org/ "https://lame.buanzo.org/")|FFMPEG plugin for Audacity|[LGPL-2.1-only](https://spdx.org/licenses/LGPL-2.1-only "https://spdx.org/licenses/LGPL-2.1-only")|
|[audacity-lame-plugin](http://lame.buanzo.org/ "http://lame.buanzo.org/")|[3.100](http://lame.buanzo.org/ "http://lame.buanzo.org/")|LAME plugin for Audacity|[LGPL-2.0-Only](https://sourceforge.net/p/lame/svn/HEAD/tree/trunk/lame/COPYING "https://sourceforge.net/p/lame/svn/HEAD/tree/trunk/lame/COPYING")|
|[audacity_installer](https://github.com/rasa/audacity_installer "https://github.com/rasa/audacity_installer")|[2.1.2](https://github.com/rasa/audacity_installer "https://github.com/rasa/audacity_installer")||[MIT](https://spdx.org/licenses/MIT "https://spdx.org/licenses/MIT")|
|[babelpad](http://www.babelstone.co.uk/Software/BabelPad.html "http://www.babelstone.co.uk/Software/BabelPad.html")|[15.1.0.4](http://www.babelstone.co.uk/Software/BabelPad.html "http://www.babelstone.co.uk/Software/BabelPad.html")|Unicode text editor|[Freeware](https://en.wikipedia.org/wiki/Freeware "https://en.wikipedia.org/wiki/Freeware")|
|[brave](https://brave.com "https://brave.com")|[1.65.126-91](https://portapps.io/app/brave-portable/feed.xml "https://portapps.io/app/brave-portable/feed.xml")|Secure, Fast & Private Web Browser with Adblocker|[Freeware,BSD-3-Clause,GPL-3.0-only,...](https://github.com/brave/brave-browser/blob/master/LICENSE "https://github.com/brave/brave-browser/blob/master/LICENSE")|
|[brave32](https://brave.com "https://brave.com")|[1.20.110-71](https://portapps.io/app/brave-portable/feed.xml "https://portapps.io/app/brave-portable/feed.xml")|Secure, Fast & Private Web Browser with Adblocker (last 32 bit version)|[Freeware,BSD-3-Clause,GPL-3.0-only,...](https://github.com/brave/brave-browser/blob/master/LICENSE "https://github.com/brave/brave-browser/blob/master/LICENSE")|
|[cpdf](http://community.coherentpdf.com/ "http://community.coherentpdf.com/")|[v2.7](https://api.github.com/repos/johnwhitington/cpdf-source/tags "https://api.github.com/repos/johnwhitington/cpdf-source/tags")|Powerful PDF manipulation tool|[Freeware](https://raw.githubusercontent.com/coherentgraphics/cpdf-binaries/master/LICENSE "https://raw.githubusercontent.com/coherentgraphics/cpdf-binaries/master/LICENSE")|
|[deletedosdevice](http://www.uwe-sieber.de/drivetools_e.html "http://www.uwe-sieber.de/drivetools_e.html")|[0.4](http://www.uwe-sieber.de/drivetools_e.html "http://www.uwe-sieber.de/drivetools_e.html")|Delete DOS device|[Freeware](https://en.wikipedia.org/wiki/Freeware "https://en.wikipedia.org/wiki/Freeware")|
|[diffpdf](http://soft.rubypdf.com/software/diffpdf "http://soft.rubypdf.com/software/diffpdf")|[2.1.3](http://soft.rubypdf.com/software/diffpdf "http://soft.rubypdf.com/software/diffpdf")|Compare two PDF files|[GPL-2.0-only](https://spdx.org/licenses/GPL-2.0-only "https://spdx.org/licenses/GPL-2.0-only")|
|[diskspd](https://github.com/microsoft/diskspd "https://github.com/microsoft/diskspd")|[2.2](https://github.com/microsoft/diskspd "https://github.com/microsoft/diskspd")|A Robust Storage Testing Tool|[MIT](https://spdx.org/licenses/MIT "https://spdx.org/licenses/MIT")|
|[display-changer](https://12noon.com/?page_id=80 "https://12noon.com/?page_id=80")|[4.6.9](https://12noon.com/?page_id=80 "https://12noon.com/?page_id=80")|Display Changer changes your Windows display resolution for all your displays (CLI).|[Freeware](https://en.wikipedia.org/wiki/Freeware "https://en.wikipedia.org/wiki/Freeware")|
|[display-changer-ii](https://12noon.com/?page_id=641 "https://12noon.com/?page_id=641")|[1.8.9](https://12noon.com/?page_id=641 "https://12noon.com/?page_id=641")|Display Changer II changes your Windows display resolution for all your displays (CLI)|[Freeware](https://en.wikipedia.org/wiki/Freeware "https://en.wikipedia.org/wiki/Freeware")|
|[dnsbench](https://www.grc.com/dns/benchmark.htm "https://www.grc.com/dns/benchmark.htm")|[1.3.6688.0](https://www.grc.com/dns/benchmark.htm "https://www.grc.com/dns/benchmark.htm")|Benchmark DNS servers|[Freeware](https://en.wikipedia.org/wiki/Freeware "https://en.wikipedia.org/wiki/Freeware")|
|[drivecleanup](http://www.uwe-sieber.de/drivetools_e.html "http://www.uwe-sieber.de/drivetools_e.html")|[1.6.5](http://www.uwe-sieber.de/drivetools_e.html "http://www.uwe-sieber.de/drivetools_e.html")|Remove nonpresent drives from the registry|[Freeware](https://en.wikipedia.org/wiki/Freeware "https://en.wikipedia.org/wiki/Freeware")|
|[dskwipe](https://github.com/rasa/dskwipe "https://github.com/rasa/dskwipe")|[1.3](https://github.com/rasa/dskwipe "https://github.com/rasa/dskwipe")|Securely wipe disk media|[MIT](https://spdx.org/licenses/MIT "https://spdx.org/licenses/MIT")|
|[ejectmedia](http://www.uwe-sieber.de/drivetools_e.html "http://www.uwe-sieber.de/drivetools_e.html")|[3.2.1](http://www.uwe-sieber.de/drivetools_e.html "http://www.uwe-sieber.de/drivetools_e.html")|Eject removable media|[Freeware](https://en.wikipedia.org/wiki/Freeware "https://en.wikipedia.org/wiki/Freeware")|
|[ejecttcv](http://www.uwe-sieber.de/drivetools_e.html "http://www.uwe-sieber.de/drivetools_e.html")|[3.2.0](http://www.uwe-sieber.de/drivetools_e.html "http://www.uwe-sieber.de/drivetools_e.html")|Eject TrueCrypt/VeraCrypt volume|[Freeware](https://en.wikipedia.org/wiki/Freeware "https://en.wikipedia.org/wiki/Freeware")|
|[emet](https://technet.microsoft.com/en-us/security/jj653751 "https://technet.microsoft.com/en-us/security/jj653751")|[5.52](https://technet.microsoft.com/en-us/security/jj653751 "https://technet.microsoft.com/en-us/security/jj653751")|Enhanced Mitigation Experience Toolkit|MSEULA|
|[eolfix](https://github.com/rasa/eolfix "https://github.com/rasa/eolfix")|[0.3.0](https://github.com/rasa/eolfix "https://github.com/rasa/eolfix")|Report & fix end-of-line characters|[MIT](https://spdx.org/licenses/MIT "https://spdx.org/licenses/MIT")|
|[exetype](https://github.com/rasa/exetype "https://github.com/rasa/exetype")|[1.5](https://github.com/rasa/exetype "https://github.com/rasa/exetype")|Display the type of a Windows EXE file|[MIT](https://spdx.org/licenses/MIT "https://spdx.org/licenses/MIT")|
|[feedster](https://github.com/rasa/feedster "https://github.com/rasa/feedster")|[0.5.0](https://github.com/rasa/feedster "https://github.com/rasa/feedster")|Easily tag MP3 files and generate iTunes podcast feed|[MIT](https://spdx.org/licenses/MIT "https://spdx.org/licenses/MIT")|
|[ffb](http://www.uwe-sieber.de/drivetools_e.html "http://www.uwe-sieber.de/drivetools_e.html")|[1.0](http://www.uwe-sieber.de/drivetools_e.html "http://www.uwe-sieber.de/drivetools_e.html")|Flush file buffers|[Freeware](https://en.wikipedia.org/wiki/Freeware "https://en.wikipedia.org/wiki/Freeware")|
|[getjpegs](https://github.com/rasa/getjpegs "https://github.com/rasa/getjpegs")|[1.5](https://github.com/rasa/getjpegs "https://github.com/rasa/getjpegs")|Recover .jpg files directly from disk|[MIT](https://spdx.org/licenses/MIT "https://spdx.org/licenses/MIT")|
|[gifsicle](https://eternallybored.org/misc/gifsicle/ "https://eternallybored.org/misc/gifsicle/")|[1.95](https://eternallybored.org/misc/gifsicle/ "https://eternallybored.org/misc/gifsicle/")|Manipulate GIF images|[GPL-2.0-only](https://spdx.org/licenses/GPL-2.0-only "https://spdx.org/licenses/GPL-2.0-only")|
|[git-all](https://gitforwindows.org "https://gitforwindows.org")|[2.45.2.windows.1](https://gitforwindows.org "https://gitforwindows.org")|Distributed version control system. (All .exes shimmed)|[GPL-2.0-only](https://spdx.org/licenses/GPL-2.0-only "https://spdx.org/licenses/GPL-2.0-only")|
|[gsmartcontrol](http://gsmartcontrol.sourceforge.net/home/index.php/Downloads "http://gsmartcontrol.sourceforge.net/home/index.php/Downloads")|[1.1.4](http://gsmartcontrol.sourceforge.net/home/index.php/Downloads "http://gsmartcontrol.sourceforge.net/home/index.php/Downloads")|GUI frontend for smartmontools (Read SMART data from disks)|[GPL-2.0](https://spdx.org/licenses/GPL-2.0 "https://spdx.org/licenses/GPL-2.0")|
|[hash-explorer](https://www.mannerud.org/tom-andreas/software/toms-hash-explorer/ "https://www.mannerud.org/tom-andreas/software/toms-hash-explorer/")|[1.2](https://www.mannerud.org/tom-andreas/software/toms-hash-explorer/ "https://www.mannerud.org/tom-andreas/software/toms-hash-explorer/")|Calculate cryptographic hash values (GUI)|[Freeware](https://en.wikipedia.org/wiki/Freeware "https://en.wikipedia.org/wiki/Freeware")|
|[hhreg](https://www.helpandmanual.com/products_hhreg.html "https://www.helpandmanual.com/products_hhreg.html")|[1.3](https://www.helpandmanual.com/products_hhreg.html "https://www.helpandmanual.com/products_hhreg.html")|Register .chm files|[Freeware](https://en.wikipedia.org/wiki/Freeware "https://en.wikipedia.org/wiki/Freeware")|
|[htmlhelp](https://msdn.microsoft.com/en-us/library/windows/desktop/ms669985(v=vs.85).aspx "https://msdn.microsoft.com/en-us/library/windows/desktop/ms669985(v=vs.85).aspx")|[1.3](https://msdn.microsoft.com/en-us/library/windows/desktop/ms669985(v=vs.85).aspx "https://msdn.microsoft.com/en-us/library/windows/desktop/ms669985(v=vs.85).aspx")|Microsoft HTML Help Compiler|[Freeware](https://en.wikipedia.org/wiki/Freeware "https://en.wikipedia.org/wiki/Freeware")|
|[id3mtag](https://squell.github.io/id3/ "https://squell.github.io/id3/")|[0.81](https://squell.github.io/id3/ "https://squell.github.io/id3/")|ID3 mass tagger|[BSD-2-Clause](https://spdx.org/licenses/BSD-2-Clause "https://spdx.org/licenses/BSD-2-Clause")|
|[inirw](https://github.com/rasa/inirw "https://github.com/rasa/inirw")|[1.4](https://github.com/rasa/inirw "https://github.com/rasa/inirw")|Read and write .INI files|[MIT](https://spdx.org/licenses/MIT "https://spdx.org/licenses/MIT")|
|[isobuster](https://www.isobuster.com/ "https://www.isobuster.com/")|[5.4.1](https://www.isobuster.com/download.php "https://www.isobuster.com/download.php")|The ultimate data recovery software|[Shareware](https://en.wikipedia.org/wiki/Shareware "https://en.wikipedia.org/wiki/Shareware")|
|[kpcli](https://sourceforge.net/projects/kpcli/ "https://sourceforge.net/projects/kpcli/")|[4.1](https://sourceforge.net/projects/kpcli/files/ "https://sourceforge.net/projects/kpcli/files/")|Command line tool for keepass databases (.kdb or .kdbx)|[Artistic-1.0-Perl](https://spdx.org/licenses/Artistic-1.0-Perl "https://spdx.org/licenses/Artistic-1.0-Perl")|
|[lgpo](https://www.microsoft.com/en-us/download/details.aspx?id=55319 "https://www.microsoft.com/en-us/download/details.aspx?id=55319")|[3.0.2004.13001](https://www.microsoft.com/en-us/download/details.aspx?id=55319 "https://www.microsoft.com/en-us/download/details.aspx?id=55319")|Manage local group policy objects (LGPO)|[Freeware](https://en.wikipedia.org/wiki/Freeware "https://en.wikipedia.org/wiki/Freeware")|
|[listdosdevices](http://www.uwe-sieber.de/drivetools_e.html "http://www.uwe-sieber.de/drivetools_e.html")|[0.2.1](http://www.uwe-sieber.de/drivetools_e.html "http://www.uwe-sieber.de/drivetools_e.html")|List DOS devices|[Freeware](https://en.wikipedia.org/wiki/Freeware "https://en.wikipedia.org/wiki/Freeware")|
|[listusbdrives](https://www.uwe-sieber.de/usbdlm_e.html "https://www.uwe-sieber.de/usbdlm_e.html")|[5.2.8](https://www.uwe-sieber.de/usbdlm_e.html "https://www.uwe-sieber.de/usbdlm_e.html")|List USB drives|[Freeware](https://en.wikipedia.org/wiki/Freeware "https://en.wikipedia.org/wiki/Freeware")|
|[loadmedia](http://www.uwe-sieber.de/drivetools_e.html "http://www.uwe-sieber.de/drivetools_e.html")|[1.5](http://www.uwe-sieber.de/drivetools_e.html "http://www.uwe-sieber.de/drivetools_e.html")|Load removable media|[Freeware](https://en.wikipedia.org/wiki/Freeware "https://en.wikipedia.org/wiki/Freeware")|
|[lsdsk](https://github.com/rasa/lsdsk "https://github.com/rasa/lsdsk")|[1.8](https://github.com/rasa/lsdsk "https://github.com/rasa/lsdsk")|List mounted disks|[MIT](https://spdx.org/licenses/MIT "https://spdx.org/licenses/MIT")|
|[ltrdata](http://www.ltr-data.se/opencode.html/#CmdUtils "http://www.ltr-data.se/opencode.html/#CmdUtils")|[2023.10.25](http://www.ltr-data.se/opencode.html/#CmdUtils "http://www.ltr-data.se/opencode.html/#CmdUtils")|ltr-data.se freeware utilities|[MIT](https://spdx.org/licenses/MIT "https://spdx.org/licenses/MIT")|
|[mklnk](https://github.com/rasa/mklnk "https://github.com/rasa/mklnk")|[1.5](https://github.com/rasa/mklnk "https://github.com/rasa/mklnk")|Make .lnk files|[MIT](https://spdx.org/licenses/MIT "https://spdx.org/licenses/MIT")|
|[msttcorefonts](https://sourceforge.net/projects/corefonts "https://sourceforge.net/projects/corefonts")|[1.3](https://sourceforge.net/projects/corefonts/rss?path=/ "https://sourceforge.net/projects/corefonts/rss?path=/")|Microsoft's TrueType core fonts|[Freeware](https://en.wikipedia.org/wiki/Freeware "https://en.wikipedia.org/wiki/Freeware")|
|[mtee](https://ritchielawrence.github.io/mtee/ "https://ritchielawrence.github.io/mtee/")|[2.21](https://ritchielawrence.github.io/mtee/ "https://ritchielawrence.github.io/mtee/")|Split standard output to a file|[MIT](https://spdx.org/licenses/MIT "https://spdx.org/licenses/MIT")|
|[mvmc](https://techcommunity.microsoft.com/t5/system-center-blog/microsoft-virtual-machine-converter-mvmc-is-being-retired/ba-p/351541 "https://techcommunity.microsoft.com/t5/system-center-blog/microsoft-virtual-machine-converter-mvmc-is-being-retired/ba-p/351541")|[3.0](https://techcommunity.microsoft.com/t5/system-center-blog/microsoft-virtual-machine-converter-mvmc-is-being-retired/ba-p/351541 "https://techcommunity.microsoft.com/t5/system-center-blog/microsoft-virtual-machine-converter-mvmc-is-being-retired/ba-p/351541")|Convert VMs/disks from VMware to Hyper-V/Azure or convert computers and disks to Hyper-V|[Freeware](https://en.wikipedia.org/wiki/Freeware "https://en.wikipedia.org/wiki/Freeware")|
|[nirlauncher](https://launcher.nirsoft.net/ "https://launcher.nirsoft.net/")|[1.30.12](https://launcher.nirsoft.net/downloads/index.html "https://launcher.nirsoft.net/downloads/index.html")|More than 200 portable freeware utilities for Windows, all of them developed for NirSoft Web site during the last few years (no shortcuts)|[Freeware](https://en.wikipedia.org/wiki/Freeware "https://en.wikipedia.org/wiki/Freeware")|
|[noto-fonts](https://www.google.com/get/noto/ "https://www.google.com/get/noto/")|[2017.10.25](https://www.google.com/get/noto/ "https://www.google.com/get/noto/")|All noto fonts|[OFL-1.1](https://spdx.org/licenses/OFL-1.1 "https://spdx.org/licenses/OFL-1.1")|
|[noto-mono-font](https://www.google.com/get/noto/ "https://www.google.com/get/noto/")|[2017.10.25](https://www.google.com/get/noto/ "https://www.google.com/get/noto/")|Noto monospaced font|[OFL-1.1](https://spdx.org/licenses/OFL-1.1 "https://spdx.org/licenses/OFL-1.1")|
|[noto-sans-font](https://www.google.com/get/noto/ "https://www.google.com/get/noto/")|[2017.10.25](https://www.google.com/get/noto/ "https://www.google.com/get/noto/")|Noto sans serif display font|[OFL-1.1](https://spdx.org/licenses/OFL-1.1 "https://spdx.org/licenses/OFL-1.1")|
|[noto-serif-font](https://www.google.com/get/noto/ "https://www.google.com/get/noto/")|[2017.10.25](https://www.google.com/get/noto/ "https://www.google.com/get/noto/")|Noto serif font|[OFL-1.1](https://spdx.org/licenses/OFL-1.1 "https://spdx.org/licenses/OFL-1.1")|
|[ntttcp](https://gallery.technet.microsoft.com/NTttcp-Version-528-Now-f8b12769 "https://gallery.technet.microsoft.com/NTttcp-Version-528-Now-f8b12769")|[5.33](https://gallery.technet.microsoft.com/NTttcp-Version-528-Now-f8b12769 "https://gallery.technet.microsoft.com/NTttcp-Version-528-Now-f8b12769")|Profile and Measure Windows Networking Performance|Custom|
|[outwit](https://www.spinellis.gr/sw/outwit/ "https://www.spinellis.gr/sw/outwit/")|[1.25](https://www.spinellis.gr/sw/outwit/ "https://www.spinellis.gr/sw/outwit/")|Diomidis Spinellis's outwit suite|[Freeware](https://raw.githubusercontent.com/dspinellis/outwit/master/LICENSE "https://raw.githubusercontent.com/dspinellis/outwit/master/LICENSE")|
|[path-set](https://github.com/rasa/path_set "https://github.com/rasa/path_set")|[1.6](https://github.com/rasa/path_set "https://github.com/rasa/path_set")|Modify system and user environment variables|[MIT](https://spdx.org/licenses/MIT "https://spdx.org/licenses/MIT")|
|[pfm2afm]( "")|1.11|Convert .PFM files to .AFM files|[Freeware](https://en.wikipedia.org/wiki/Freeware "https://en.wikipedia.org/wiki/Freeware")|
|[policy-analyzer](https://www.microsoft.com/en-us/download/details.aspx?id=55319 "https://www.microsoft.com/en-us/download/details.aspx?id=55319")|[4.0.2004.13001](https://www.microsoft.com/en-us/download/details.aspx?id=55319 "https://www.microsoft.com/en-us/download/details.aspx?id=55319")|LGPO policy analyzer|MSEULA|
|[poweroff](https://duofoto.be/jbosman/applications.html "https://duofoto.be/jbosman/applications.html")|[3.0.1.3](https://duofoto.be/jbosman/applications.html "https://duofoto.be/jbosman/applications.html")|Poweroff system utility|[Freeware](https://en.wikipedia.org/wiki/Freeware "https://en.wikipedia.org/wiki/Freeware")|
|[py](https://bitbucket.org/vinay.sajip/pylauncher/downloads/ "https://bitbucket.org/vinay.sajip/pylauncher/downloads/")|[1.0.1.6](https://bitbucket.org/vinay.sajip/pylauncher/downloads/ "https://bitbucket.org/vinay.sajip/pylauncher/downloads/")|Find and launch Python|[BSD-3-Clause](https://spdx.org/licenses/BSD-3-Clause "https://spdx.org/licenses/BSD-3-Clause")|
|[regdelta](https://github.com/rasa/regdelta "https://github.com/rasa/regdelta")|[1.1](https://github.com/rasa/regdelta "https://github.com/rasa/regdelta")|Diff, export, and sort Windows registry files|[MIT](https://spdx.org/licenses/MIT "https://spdx.org/licenses/MIT")|
|[rehash](http://rehash.sourceforge.net/ "http://rehash.sourceforge.net/")|[0.2](https://sourceforge.net/projects/rehash/files/ "https://sourceforge.net/projects/rehash/files/")|Calculate file hashes|[BSD-2-Clause](https://spdx.org/licenses/BSD-2-Clause "https://spdx.org/licenses/BSD-2-Clause")|
|[remount](http://www.uwe-sieber.de/drivetools_e.html "http://www.uwe-sieber.de/drivetools_e.html")|[2.3.1](http://www.uwe-sieber.de/drivetools_e.html "http://www.uwe-sieber.de/drivetools_e.html")|Remount ejected volumes|[Freeware](https://en.wikipedia.org/wiki/Freeware "https://en.wikipedia.org/wiki/Freeware")|
|[removedrive](http://www.uwe-sieber.de/drivetools_e.html "http://www.uwe-sieber.de/drivetools_e.html")|[3.4.4](http://www.uwe-sieber.de/drivetools_e.html "http://www.uwe-sieber.de/drivetools_e.html")|Safely removes drives|[Freeware](https://en.wikipedia.org/wiki/Freeware "https://en.wikipedia.org/wiki/Freeware")|
|[res-set](https://github.com/rasa/res_set "https://github.com/rasa/res_set")|[1.9](https://github.com/rasa/res_set "https://github.com/rasa/res_set")|Display or change the monitor resolution, color depth, or refresh rate|[MIT](https://spdx.org/licenses/MIT "https://spdx.org/licenses/MIT")|
|[rescandevices](http://www.uwe-sieber.de/drivetools_e.html "http://www.uwe-sieber.de/drivetools_e.html")|[0.1](http://www.uwe-sieber.de/drivetools_e.html "http://www.uwe-sieber.de/drivetools_e.html")|Rescan devices|[Freeware](https://en.wikipedia.org/wiki/Freeware "https://en.wikipedia.org/wiki/Freeware")|
|[restartsrdev](http://www.uwe-sieber.de/drivetools_e.html "http://www.uwe-sieber.de/drivetools_e.html")|[3.1](http://www.uwe-sieber.de/drivetools_e.html "http://www.uwe-sieber.de/drivetools_e.html")|Restart safely removed media|[Freeware](https://en.wikipedia.org/wiki/Freeware "https://en.wikipedia.org/wiki/Freeware")|
|[seterlvl](https://github.com/rasa/seterlvl "https://github.com/rasa/seterlvl")|[1.4](https://github.com/rasa/seterlvl "https://github.com/rasa/seterlvl")|Set the errorlevel and exit|[MIT](https://spdx.org/licenses/MIT "https://spdx.org/licenses/MIT")|
|[simple-dnscrypt](https://simplednscrypt.org/ "https://simplednscrypt.org/")|[0.7.1](https://simplednscrypt.org/ "https://simplednscrypt.org/")|Simple management tool for dnscrypt-proxy|[MIT](https://spdx.org/licenses/MIT "https://spdx.org/licenses/MIT")|
|[stc](https://github.com/tenox7/stc "https://github.com/tenox7/stc")|[1.4](https://github.com/tenox7/stc "https://github.com/tenox7/stc")|Syncthing Cli|[Apache-2.0](https://spdx.org/licenses/Apache-2.0 "https://spdx.org/licenses/Apache-2.0")|
|[sysinternals](https://docs.microsoft.com/en-us/sysinternals/ "https://docs.microsoft.com/en-us/sysinternals/")|[2024.06.20](https://raw.githubusercontent.com/MicrosoftDocs/sysinternals/main/sysinternals/downloads/sysinternals-suite.md "https://raw.githubusercontent.com/MicrosoftDocs/sysinternals/main/sysinternals/downloads/sysinternals-suite.md")|A set of utilities to manage, diagnose, troubleshoot, and monitor a Windows environment. (no shortcuts)|[Freeware](https://docs.microsoft.com/en-us/sysinternals/license-terms "https://docs.microsoft.com/en-us/sysinternals/license-terms")|
|[time-it](https://github.com/rasa/time_it "https://github.com/rasa/time_it")|[1.2](https://github.com/rasa/time_it "https://github.com/rasa/time_it")|Time disk I/O|[MIT](https://spdx.org/licenses/MIT "https://spdx.org/licenses/MIT")|
|[usbdeview-ids](http://www.linux-usb.org/usb-ids.html "http://www.linux-usb.org/usb-ids.html")|[latest](http://www.linux-usb.org/usb-ids.html "http://www.linux-usb.org/usb-ids.html")|USB device database used by Nirsoft's usbdeview|[GPL-2.0-only](https://spdx.org/licenses/GPL-2.0-only "https://spdx.org/licenses/GPL-2.0-only")|
|[usbdlm](https://www.uwe-sieber.de/usbdlm_e.html "https://www.uwe-sieber.de/usbdlm_e.html")|[5.6.1](https://www.uwe-sieber.de/usbdlm_e.html "https://www.uwe-sieber.de/usbdlm_e.html")|USB Drive Letter Manager|[Freeware](https://en.wikipedia.org/wiki/Freeware "https://en.wikipedia.org/wiki/Freeware")|
|[usbtreeview](https://www.uwe-sieber.de/usbtreeview_e.html "https://www.uwe-sieber.de/usbtreeview_e.html")|[4.3.0](https://www.uwe-sieber.de/usbtreeview_e.html "https://www.uwe-sieber.de/usbtreeview_e.html")|USB device tree viewer|[Freeware](https://en.wikipedia.org/wiki/Freeware "https://en.wikipedia.org/wiki/Freeware")|
|[vvv](https://www.fsoft.it/VVV/ "https://www.fsoft.it/VVV/")|[1.5](https://www.fsoft.it/VVV/versions.html "https://www.fsoft.it/VVV/versions.html")|Virtual Volumes View: Catalog contents of removable volumes like CD and DVD disks for off-line searching.|[GPL-2.0](https://spdx.org/licenses/GPL-2.0 "https://spdx.org/licenses/GPL-2.0")|
|[wfc](https://www.binisoft.org/wfc.php "https://www.binisoft.org/wfc.php")|[6.11.0.0](https://www.binisoft.org/wfc.php "https://www.binisoft.org/wfc.php")|Powerful tool which extends the functionality of Windows Firewall and provides new extra features which makes Windows Firewall better|[Freeware](https://en.wikipedia.org/wiki/Freeware "https://en.wikipedia.org/wiki/Freeware")|
|[wizmo](https://www.grc.com/wizmo/wizmo.htm "https://www.grc.com/wizmo/wizmo.htm")|[1.1](https://www.grc.com/wizmo/wizmo.htm "https://www.grc.com/wizmo/wizmo.htm")|Steve Gibson's multi-purpose Windows gizmo|[Freeware](https://en.wikipedia.org/wiki/Freeware "https://en.wikipedia.org/wiki/Freeware")|
|[wolcmd](https://www.depicus.com/wake-on-lan/wake-on-lan-cmd "https://www.depicus.com/wake-on-lan/wake-on-lan-cmd")|[1.1](https://www.depicus.com/wake-on-lan/wake-on-lan-cmd "https://www.depicus.com/wake-on-lan/wake-on-lan-cmd")|WOL (Wake-On-Lan) CLI tool|[Freeware](https://en.wikipedia.org/wiki/Freeware "https://en.wikipedia.org/wiki/Freeware")|
|[ztree](https://www.ztree.com/html/ztreewin.htm "https://www.ztree.com/html/ztreewin.htm")|[2.2](https://www.ztree.com/html/ztreewin.htm "https://www.ztree.com/html/ztreewin.htm")|Text-mode file/directory manager|[Shareware](https://en.wikipedia.org/wiki/Shareware "https://en.wikipedia.org/wiki/Shareware")|
|[ztree-beta](https://www.ztree.com/html/beta.htm "https://www.ztree.com/html/beta.htm")|[2.4.199](https://www.ztree.com/html/beta.htm "https://www.ztree.com/html/beta.htm")|Text-mode file/directory manager (beta version)|[Shareware](https://en.wikipedia.org/wiki/Shareware "https://en.wikipedia.org/wiki/Shareware")|
|[ztree-zeta](https://www.ztw3.com/forum/search.php?search=%5Bzeta%5D "https://www.ztw3.com/forum/search.php?search=%5Bzeta%5D")|[2.4.217](https://www.ztw3.com/forum/search.php?search=%5Bzeta%5D "https://www.ztw3.com/forum/search.php?search=%5Bzeta%5D")|Text-mode file/directory manager (zeta version)|[Shareware](https://en.wikipedia.org/wiki/Shareware "https://en.wikipedia.org/wiki/Shareware")|

## Migrated Apps

The following apps have been migrated to another scoop bucket:

|New Bucket|Name|Version|Description|License|
|------------|----|-------|-----------|-------|
|[extras](https://github.com/ScoopInstaller/Extras/blob/master/bucket/babelmap.json)|[babelmap](http://www.babelstone.co.uk/Software/BabelMap.html "http://www.babelstone.co.uk/Software/BabelMap.html")|[12.1.0.1](http://www.babelstone.co.uk/Software/BabelMap.html "http://www.babelstone.co.uk/Software/BabelMap.html")|Display Unicode character maps|[Freeware](https://en.wikipedia.org/wiki/Freeware "https://en.wikipedia.org/wiki/Freeware")|
|[main](https://github.com/ScoopInstaller/Main/blob/master/bucket/cacert.json)|[cacert](https://curl.haxx.se/docs/caextract.html "https://curl.haxx.se/docs/caextract.html")|[2017-01-18](https://curl.haxx.se/docs/caextract.html "https://curl.haxx.se/docs/caextract.html")|Mozilla CA certificate store in PEM format|[MPL-2.0](https://opensource.org/licenses/MPL-2.0 "https://opensource.org/licenses/MPL-2.0")|
|[main](https://github.com/ScoopInstaller/Main/blob/master/bucket/cdrtools.json)|[cdrtools](https://sourceforge.net/projects/tumagcc/ "https://sourceforge.net/projects/tumagcc/")|[3.01](https://sourceforge.net/projects/tumagcc/ "https://sourceforge.net/projects/tumagcc/")|Burn and read CDs, DVDs, and Blu-ray discs|[CDDL-1.0](https://opensource.org/licenses/CDDL-1.0 "https://opensource.org/licenses/CDDL-1.0")/[GPL-2.0](https://opensource.org/licenses/GPL-2.0 "https://opensource.org/licenses/GPL-2.0")/[LGPL-2.1](https://opensource.org/licenses/LGPL-2.1 "https://opensource.org/licenses/LGPL-2.1")|
|[extras](https://github.com/ScoopInstaller/Extras/blob/master/bucket/cherrytree.json)|[cherrytree](https://www.giuspen.com/cherrytree "https://www.giuspen.com/cherrytree")|[0.38.7](https://www.giuspen.com/cherrytree "https://www.giuspen.com/cherrytree")|Hierarchical note taking application|[GPL-3.0](https://opensource.org/licenses/GPL-3.0 "https://opensource.org/licenses/GPL-3.0")|
|[extras](https://github.com/ScoopInstaller/Extras/blob/master/bucket/cmdow.json)|[cmdow](https://ritchielawrence.github.io/cmdow/ "https://ritchielawrence.github.io/cmdow/")|[1.4.8](https://ritchielawrence.github.io/cmdow/ "https://ritchielawrence.github.io/cmdow/")|Manipulate program windows|[MIT](https://opensource.org/licenses/MIT "https://opensource.org/licenses/MIT")|
|[extras](https://github.com/ScoopInstaller/Extras/blob/master/bucket/fastcopy.json)|[fastcopy](https://fastcopy.jp/en/ "https://fastcopy.jp/en/")|[3.54](https://fastcopy.jp/en/ "https://fastcopy.jp/en/")|The Fastest Copy/Delete Software on Windows|[GPL-3.0-only](https://opensource.org/licenses/GPL-3.0-only "https://opensource.org/licenses/GPL-3.0-only")|
|[main](https://github.com/ScoopInstaller/Main/blob/master/bucket/fat32format.json)|[fat32format](https://github.com/0xbadfca11/fat32format "https://github.com/0xbadfca11/fat32format")|[a027932](https://github.com/0xbadfca11/fat32format "https://github.com/0xbadfca11/fat32format")|Format disk media using FAT32|[GPL-2.0-only](https://opensource.org/licenses/GPL-2.0-only "https://opensource.org/licenses/GPL-2.0-only")|
|[extras](https://github.com/ScoopInstaller/Extras/blob/master/bucket/handbrake.json)|[handbrake](https://handbrake.fr/ "https://handbrake.fr/")|[1.0.7](https://handbrake.fr/ "https://handbrake.fr/")|Convert videos with GUI program|[GPL-2.0](https://opensource.org/licenses/GPL-2.0 "https://opensource.org/licenses/GPL-2.0")|
|[main](https://github.com/ScoopInstaller/Main/blob/master/bucket/handbrake-cli.json)|[handbrake_cli](https://handbrake.fr/ "https://handbrake.fr/")|[1.0.3](https://handbrake.fr/downloads2.php "https://handbrake.fr/downloads2.php")|Convert videos with CLI program|[GPL-2.0](https://opensource.org/licenses/GPL-2.0 "https://opensource.org/licenses/GPL-2.0")|
|[main](https://github.com/ScoopInstaller/Main/blob/master/bucket/inadyn-mt.json)|[inadyn-mt](https://sourceforge.net/projects/inadyn-mt/files/inadyn-mt/ "https://sourceforge.net/projects/inadyn-mt/files/inadyn-mt/")|[02.28.10](https://handbrake.fr/downloads2.php "https://handbrake.fr/downloads2.php")|Dynamic DNS client|[GPL-3.0](https://opensource.org/licenses/GPL-3.0 "https://opensource.org/licenses/GPL-3.0")|
|[main](https://github.com/ScoopInstaller/Main/blob/master/bucket/unzip.json)|[infounzip](http://www.info-zip.org/ "http://www.info-zip.org/")|[6.00](http://www.info-zip.org/ "http://www.info-zip.org/")|Unzip compression utility|[Link](http://www.info-zip.org/pub/infozip/license.html "http://www.info-zip.org/pub/infozip/license.html")|
|[main](https://github.com/ScoopInstaller/Main/blob/master/bucket/zip.json)|[infozip](http://www.info-zip.org/ "http://www.info-zip.org/")|[3.0](http://www.info-zip.org/ "http://www.info-zip.org/")|Zip compression utilities|[Link](http://www.info-zip.org/pub/infozip/license.html "http://www.info-zip.org/pub/infozip/license.html")|
|[main](https://github.com/ScoopInstaller/Main/blob/master/bucket/jdupes.json)|[jdupes](https://github.com/jbruchon/jdupes "https://github.com/jbruchon/jdupes")|[1.12](https://github.com/jbruchon/jdupes "https://github.com/jbruchon/jdupes")|A powerful duplicate file finder and an enhanced fork of 'fdupes'|[MIT](https://opensource.org/licenses/MIT "https://opensource.org/licenses/MIT")|
|[main](https://github.com/ScoopInstaller/Main/blob/master/bucket/mailsend.json)|[mailsend](https://github.com/muquit/mailsend/ "https://github.com/muquit/mailsend/")|[1.19](https://github.com/muquit/mailsend/ "https://github.com/muquit/mailsend/")|Send mail via SMTP|[BSD-3-Clause](https://opensource.org/licenses/BSD-3-Clause "https://opensource.org/licenses/BSD-3-Clause")|
|[main](https://github.com/ScoopInstaller/Main/blob/master/bucket/metastore.json)|[metastore](https://github.com/rasa/metastore "https://github.com/rasa/metastore")|[95d4e2d](https://github.com/rasa/metastore/releases/latest "https://github.com/rasa/metastore/releases/latest")|Store and restore metadata from a filesystem|[GPL-2.0](https://opensource.org/licenses/GPL-2.0 "https://opensource.org/licenses/GPL-2.0")|
|[main](https://github.com/ScoopInstaller/Main/blob/master/bucket/netcat.json)|[nc](https://eternallybored.org/misc/netcat/ "https://eternallybored.org/misc/netcat/") (aka netcat)|[1.12](https://eternallybored.org/misc/netcat/ "https://eternallybored.org/misc/netcat/")|Read and write from/to network connections|[GPL-2.0](https://opensource.org/licenses/GPL-2.0 "https://opensource.org/licenses/GPL-2.0")|
|[versions](https://github.com/scoopinstaller/versions/blob/master/bucket/openssl10.json)|[openssl10](http://slproweb.com/products/Win32OpenSSL.html "http://slproweb.com/products/Win32OpenSSL.html")|[1.0.2k](http://slproweb.com/products/Win32OpenSSL.html "http://slproweb.com/products/Win32OpenSSL.html")|TLS/SSL toolkit (1.0.x branch)|[Link](https://www.openssl.org/source/license.html "https://www.openssl.org/source/license.html")|
|[main](https://github.com/ScoopInstaller/Main/blob/master/bucket/pciutils.json)|[pciutils](https://eternallybored.org/misc/pciutils/ "https://eternallybored.org/misc/pciutils/")|[3.4.0](https://eternallybored.org/misc/pciutils/ "https://eternallybored.org/misc/pciutils/")|Inspect and manipulate configuration of PCI devices|[GPL-2.0](https://opensource.org/licenses/GPL-2.0 "https://opensource.org/licenses/GPL-2.0")|
|[main](https://github.com/ScoopInstaller/Main/blob/master/bucket/poppler.json)|[poppler](http://blog.alivate.com.au/poppler-windows/ "http://blog.alivate.com.au/poppler-windows/")|[0.51](http://blog.alivate.com.au/poppler-windows/ "http://blog.alivate.com.au/poppler-windows/")|PDF rendering library|[GPL-3.0](https://opensource.org/licenses/GPL-3.0 "https://opensource.org/licenses/GPL-3.0")|
|[main](https://github.com/ScoopInstaller/Main/blob/master/bucket/smartmontools.json)|[smartmontools](https://www.smartmontools.org/ "https://www.smartmontools.org/")|[6.5-1](https://sourceforge.net/projects/smartmontools/files/smartmontools/ "https://sourceforge.net/projects/smartmontools/files/smartmontools/")|Read SMART data from disks|[GPL-2.0](https://opensource.org/licenses/GPL-2.0 "https://opensource.org/licenses/GPL-2.0")|
|[main](https://github.com/ScoopInstaller/Main/blob/master/bucket/sslscan.json)|[sslscan](https://github.com/rbsec/sslscan "https://github.com/rbsec/sslscan")|[1.11.0](https://github.com/rbsec/sslscan "https://github.com/rbsec/sslscan")|Discover supported cipher suites for SSL/TLS enabled services|[GPL-3.0](https://opensource.org/licenses/GPL-3.0 "https://opensource.org/licenses/GPL-3.0")|
|[main](https://github.com/ScoopInstaller/Main/blob/master/bucket/tesseract.json)|[tesseract](https://github.com/UB-Mannheim/tesseract/wiki "https://github.com/UB-Mannheim/tesseract/wiki")|[3.05.00](https://github.com/UB-Mannheim/tesseract/wiki "https://github.com/UB-Mannheim/tesseract/wiki")|OCR engine developed by Google|[Apache-2.0](https://opensource.org/licenses/Apache-2.0 "https://opensource.org/licenses/Apache-2.0")|
|[versions](https://github.com/scoopinstaller/versions/blob/master/bucket/tesseract4.json)|[tesseract_experimental](https://github.com/UB-Mannheim/tesseract/wiki "https://github.com/UB-Mannheim/tesseract/wiki")|[4.00.00](https://github.com/UB-Mannheim/tesseract/wiki "https://github.com/UB-Mannheim/tesseract/wiki")|OCR engine developed by Google|[Apache-2.0](https://opensource.org/licenses/Apache-2.0 "https://opensource.org/licenses/Apache-2.0")|
|[main](https://github.com/ScoopInstaller/Main/blob/master/bucket/tidy.json)|[tidy](http://www.html-tidy.org/ "http://www.html-tidy.org/")|[5.4.0](http://www.html-tidy.org/ "http://www.html-tidy.org/")|Tidy HTML and XML files|[Link](http://www.html-tidy.org/documentation/#license "http://www.html-tidy.org/documentation/#license")|
|[main](https://github.com/ScoopInstaller/Main/blob/master/bucket/unrar.json)|[unrar](http://www.rarlab.com/ "http://www.rarlab.com/")|[5.40](http://www.rarlab.com/download.htm "http://www.rarlab.com/download.htm")|Uncompress RAR files|[Freeware](https://en.wikipedia.org/wiki/Freeware "https://en.wikipedia.org/wiki/Freeware")|
|[extras](https://github.com/ScoopInstaller/Extras/blob/master/bucket/windowsspyblocker.json)|[wsb](https://github.com/crazy-max/WindowsSpyBlocker "https://github.com/crazy-max/WindowsSpyBlocker")|[4.22.0](https://github.com/crazy-max/WindowsSpyBlocker "https://github.com/crazy-max/WindowsSpyBlocker")|WindowsSpyBlocker shield blocks spying and tracking on Windows systems|[MIT](https://opensource.org/licenses/MIT "https://opensource.org/licenses/MIT")|
|[main](https://github.com/ScoopInstaller/Main/blob/master/bucket/wkhtmltopdf.json)|[wkhtmltopdf](http://wkhtmltopdf.org/ "http://wkhtmltopdf.org/")|[0.12.4](http://wkhtmltopdf.org/downloads.html "http://wkhtmltopdf.org/downloads.html")|Render HTML into PDF|[LGPL-3.0](https://opensource.org/licenses/LGPL-3.0 "https://opensource.org/licenses/LGPL-3.0")|
|[main](https://github.com/ScoopInstaller/Main/blob/master/bucket/x264.json)|[x264-8bit](https://www.videolan.org/developers/x264.html "https://www.videolan.org/developers/x264.html")|[17.01.30](https://www.videolan.org/developers/x264.html "https://www.videolan.org/developers/x264.html")|H.264/MPEG-4 AVC video encoder (8 bit)|[GPL-2.0](https://opensource.org/licenses/GPL-2.0 "https://opensource.org/licenses/GPL-2.0")|
|[main](https://github.com/ScoopInstaller/Main/blob/master/bucket/xmlstarlet.json)|[xmlstarlet](http://xmlstar.sourceforge.net/ "http://xmlstar.sourceforge.net/")|[1.6.1](https://sourceforge.net/projects/xmlstar/files/ "https://sourceforge.net/projects/xmlstar/files/")|Transform, query, validate, and edit XML files|[MIT](https://opensource.org/licenses/MIT "https://opensource.org/licenses/MIT")|
|[extras](https://github.com/ScoopInstaller/Extras/blob/master/bucket/xnviewmp.json)|[xnview-mp](https://www.xnview.com/en/xnviewmp/ "https://www.xnview.com/en/xnviewmp/")|[0.97.1](https://www.xnview.com/en/xnviewmp/ "https://www.xnview.com/en/xnviewmp/")|Photo viewer, image resizer & batch converter|[Freeware](https://en.wikipedia.org/wiki/Freeware "https://en.wikipedia.org/wiki/Freeware")|

## Deprecated

The following apps have been deprecated:

|Name|Version|Description|License|
|----|-------|-----------|-------|
|[fat32format-gui](http://ridgecrop.co.uk/index.htm?guiformat.htm "http://ridgecrop.co.uk/index.htm?guiformat.htm")|[1.01](http://www.ridgecrop.demon.co.uk/index.htm?guiformat.htm "http://www.ridgecrop.demon.co.uk/index.htm?guiformat.htm")|Format disk media using FAT32 (GUI)|[GPL-2.0-only](https://opensource.org/licenses/GPL-2.0-only "https://opensource.org/licenses/GPL-2.0-only")|
|openssh-win32||||
|[tmac](https://technitium.com/tmac/ "https://technitium.com/tmac/")|[6.0.7](https://technitium.com/tmac/ "https://technitium.com/tmac/")|Spoof MAC address|[Freeware](https://en.wikipedia.org/wiki/Freeware "https://en.wikipedia.org/wiki/Freeware")|
|[vlc-bluray-plugin](https://www.videolan.org/ "https://www.videolan.org/")|[2018.03.25](https://www.videolan.org/ "https://www.videolan.org/")|VLC Blu-ray plugin|[GPL-2.0-only](https://opensource.org/licenses/GPL-2.0-only "https://opensource.org/licenses/GPL-2.0-only")|
|[vlc-installer](https://github.com/rasa/vlc_installer "https://github.com/rasa/vlc_installer")|[2.2.4](https://github.com/rasa/vlc_installer "https://github.com/rasa/vlc_installer")|Download and install the VLC media player and related plugins (deprecated)|[MIT](https://opensource.org/licenses/MIT "https://opensource.org/licenses/MIT")|

## Removed

The following apps have been removed:

|Name|Version|Description|License|
|----|-------|-----------|-------|
|[main](https://github.com/ScoopInstaller/Main/blob/master/bucket/x264-10bit.json)|[x264-10bit](https://www.videolan.org/developers/x264.html "https://www.videolan.org/developers/x264.html")|[17.01.30](https://www.videolan.org/developers/x264.html "https://www.videolan.org/developers/x264.html")|H.264/MPEG-4 AVC video encoder (10 bit)|[GPL-2.0](https://opensource.org/licenses/GPL-2.0 "https://opensource.org/licenses/GPL-2.0")|

## Bugs

To view existing bugs, or report a new bug, please see [issues](../../issues).

## License

This project is [MIT licensed](https://smithii.mit-license.org/2004).

## Contact

This project was created and is maintained by [Ross Smith II][]

Feedback, suggestions, and enhancements are welcome.

[Ross Smith II]: mailto:ross@smithii.com "ross@smithii.com"


# The Directory of Open Access Journals (DOAJ)
<!-- ~~DOAJ:Documentation~~ -->

This repository provides the software which drives the DOAJ website and the DOAJ
directory.

## Reporting issues

Please feel free to use the issue tracker on https://github.com/DOAJ/doaj/issues for any bug
reports and feature requests. If you're reporting an error, please leave as much information
as you can, e.g. whether you were on mobile or desktop, which browser, what you were trying
to accomplish, whether you saw an error code, and the time it occurred.

If you'd like to contribute and enhancement or bugfix to the DOAJ, you're more than welcome
to open a pull request!

## Documentation

<!-- ~~->Install:Documentation~~ -->
* [Install](docs/system/INSTALL.md)

<!-- ~~->AuthNZ:Documentation~~ -->
* [Authorisation and Authentication](docs/system/AUTHNZ.md)

<!-- ~~->AWS:Documentation~~ -->
* [AWS Configurations](docs/system/AWS.md)

<!-- ~~->S3:Documentation~~ -->
* [S3 Specific documentation](docs/system/S3.md)

<!-- ~~->OpenURL:Documentation~~ -->
* [OpenURL](docs/system/OPENURL.md)

<!-- ~~->DocSite:Documentation~~ -->
* [DOAJ Auto-generated docs](https://doaj.github.io/doaj-docs/) - here you will find
data models, test coverage reports, form documentation and a map of the software


# Couchers.org

[![pipeline status](https://gitlab.com/couchers/couchers/badges/develop/pipeline.svg)](https://gitlab.com/couchers/couchers/-/pipelines) [![coverage report](https://gitlab.com/couchers/couchers/badges/develop/coverage.svg)](https://develop--bcov.preview.couchershq.org)

## Join us as we build the new alternative to Couchsurfing™

Free forever. Community‑led. Non‑profit. Modern.

Read more about us at [Couchers.org](https://couchers.org).

The code in this repository is licensed under the [MIT license](license.md).

## How to contribute

If you found an issue with the app, or have a suggestion/feature you'd like to raise, please add it to the Issues (in the issues tab on GitHub). A developer will come and triage the issue and add it to the backlog.

If you are a developer, please read [docs/contributing.md](docs/contributing.md) on our development model.

## Overview of documentation

* Getting started with dev: [app/readme.md](app/readme.md) outlines basic steps to get a dev environment set up, start here!
* Architectural overview: [docs/architecture.md](docs/architecture.md) outlines the basic workings of the app, the different components, and the way they interact.
* Developer Contributor Guide: [docs/contributing.md](docs/contributing.md) explains how we work with this codebase and helps you get up and running with development.
* CI/CD goodies: [docs/cicd.md](docs/cicd.md) lists the different CI/CD functionality that we've got set up and how you can use this to simplify life
* Database & migrations: [docs/database.md](docs/database.md) explains how to use the database and how we version the database with Alembic and update it when new tables or columns are added
* Docker: [docs/docker.md](docs/docker.md) has some tips on how to work with docker and be less miserable

## Translations

Help [translate Couchers.org](https://translate.couchershq.org/).

[![translation status](https://translate.couchershq.org/widgets/couchers/-/multi-auto.svg)](https://translate.couchershq.org/engage/couchers/)

## Note on intellectual property

The source code for the Couchers.org project is licensed under the MIT license, allowing anybody to use and redistribute the code with few restrictions. However, Couchers, Inc. owns, holds exclusive copyrights to, or owns trademarks for, other intellectual property, including the logos, colour schemes, designs, and texts that appear on the platform. If you wish to reuse parts of the project, you must make sure to remove this intellectual property (including by rebranding the app) to reduce confusion and uphold the brand of Couchers.org.


# spaCy: Industrial-strength NLP

spaCy is a library for **advanced Natural Language Processing** in Python and
Cython. It's built on the very latest research, and was designed from day one to
be used in real products.

spaCy comes with [pretrained pipelines](https://spacy.io/models) and currently
supports tokenization and training for **70+ languages**. It features
state-of-the-art speed and **neural network models** for tagging, parsing,
**named entity recognition**, **text classification** and more, multi-task
learning with pretrained **transformers** like BERT, as well as a
production-ready [**training system**](https://spacy.io/usage/training) and easy
model packaging, deployment and workflow management. spaCy is commercial
open-source software, released under the
[MIT license](https://github.com/explosion/spaCy/blob/master/LICENSE).

💫 **Version 3.7 out now!**
[Check out the release notes here.](https://github.com/explosion/spaCy/releases)

[![tests](https://github.com/explosion/spaCy/actions/workflows/tests.yml/badge.svg)](https://github.com/explosion/spaCy/actions/workflows/tests.yml)
[![Current Release Version](https://img.shields.io/github/release/explosion/spacy.svg?style=flat-square&logo=github)](https://github.com/explosion/spaCy/releases)
[![pypi Version](https://img.shields.io/pypi/v/spacy.svg?style=flat-square&logo=pypi&logoColor=white)](https://pypi.org/project/spacy/)
[![conda Version](https://img.shields.io/conda/vn/conda-forge/spacy.svg?style=flat-square&logo=conda-forge&logoColor=white)](https://anaconda.org/conda-forge/spacy)
[![Python wheels](https://img.shields.io/badge/wheels-%E2%9C%93-4c1.svg?longCache=true&style=flat-square&logo=python&logoColor=white)](https://github.com/explosion/wheelwright/releases)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg?style=flat-square)](https://github.com/ambv/black)

[![PyPi downloads](https://static.pepy.tech/personalized-badge/spacy?period=total&units=international_system&left_color=grey&right_color=orange&left_text=pip%20downloads)](https://pypi.org/project/spacy/)
[![Conda downloads](https://img.shields.io/conda/dn/conda-forge/spacy?label=conda%20downloads)](https://anaconda.org/conda-forge/spacy)
[![spaCy on Twitter](https://img.shields.io/twitter/follow/spacy_io.svg?style=social&label=Follow)](https://twitter.com/spacy_io)

## 📖 Documentation

| Documentation                                                                                |                                                                                |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ⭐ **[spaCy 101]**                                                                                | New to spaCy? Here's everything you need to know!                                                                                |
| 📚 **[Usage Guides]**                                                                                | How to use spaCy and its features.                                                                                |
| 🚀 **[New in v3.0]**                                                                                | New features, backwards incompatibilities and migration guide.                                                                                |
| 🪐 **[Project Templates]**                                                                                | End-to-end workflows you can clone, modify and run.                                                                                |
| 🎛 **[API Reference]**                                                                                | The detailed reference for spaCy's API.                                                                                |
| ⏩ **[GPU Processing]**                                                                                | Use spaCy with CUDA-compatible GPU processing.                                                                                |
| 📦 **[Models]**                                                                                | Download trained pipelines for spaCy.                                                                                |
| 🦙 **[Large Language Models]**                                                                                | Integrate LLMs into spaCy pipelines.                                                                                |
| 🌌 **[Universe]**                                                                                | Plugins, extensions, demos and books from the spaCy ecosystem.                                                                                |
| ⚙ **[spaCy VS Code Extension]**                                                                                | Additional tooling and features for working with spaCy's config files.                                                                                |
| 👩🏫 **[Online Course]**                                                                                | Learn spaCy in this free and interactive online course.                                                                                |
| 📰 **[Blog]**                                                                                | Read about current spaCy and Prodigy development, releases, talks and more from Explosion.                                                                                |
| 📺 **[Videos]**                                                                                | Our YouTube channel with video tutorials, talks and more.                                                                                |
| 🛠 **[Changelog]**                                                                                | Changes and version history.                                                                                |
| 💝 **[Contribute]**                                                                                | How to contribute to the spaCy project and code base.                                                                                |
| 👕 **[Swag]**                                                                                | Support us and our work with unique, custom-designed swag!                                                                                |
|  | Custom NLP consulting, implementation and strategic advice by spaCy’s core development team. Streamlined, production-ready, predictable and maintainable. Send us an email or take our 5-minute questionnaire, and well'be in touch! **[Learn more →](https://explosion.ai/tailored-solutions)**                 |

[spacy 101]: https://spacy.io/usage/spacy-101
[new in v3.0]: https://spacy.io/usage/v3
[usage guides]: https://spacy.io/usage/
[api reference]: https://spacy.io/api/
[gpu processing]: https://spacy.io/usage#gpu
[models]: https://spacy.io/models
[large language models]: https://spacy.io/usage/large-language-models
[universe]: https://spacy.io/universe
[spacy vs code extension]: https://github.com/explosion/spacy-vscode
[videos]: https://www.youtube.com/c/ExplosionAI
[online course]: https://course.spacy.io
[blog]: https://explosion.ai
[project templates]: https://github.com/explosion/projects
[changelog]: https://spacy.io/usage#changelog
[contribute]: https://github.com/explosion/spaCy/blob/master/CONTRIBUTING.md
[swag]: https://explosion.ai/merch

## 💬 Where to ask questions

The spaCy project is maintained by the [spaCy team](https://explosion.ai/about).
Please understand that we won't be able to provide individual support via email.
We also believe that help is much more valuable if it's shared publicly, so that
more people can benefit from it.

| Type                            | Platforms                               |
| ------------------------------- | --------------------------------------- |
| 🚨 **Bug Reports**              | [GitHub Issue Tracker]                  |
| 🎁 **Feature Requests & Ideas** | [GitHub Discussions]                    |
| 👩💻 **Usage Questions**          | [GitHub Discussions] · [Stack Overflow] |
| 🗯 **General Discussion**        | [GitHub Discussions]                    |

[github issue tracker]: https://github.com/explosion/spaCy/issues
[github discussions]: https://github.com/explosion/spaCy/discussions
[stack overflow]: https://stackoverflow.com/questions/tagged/spacy

## Features

- Support for **70+ languages**
- **Trained pipelines** for different languages and tasks
- Multi-task learning with pretrained **transformers** like BERT
- Support for pretrained **word vectors** and embeddings
- State-of-the-art speed
- Production-ready **training system**
- Linguistically-motivated **tokenization**
- Components for named **entity recognition**, part-of-speech-tagging,
  dependency parsing, sentence segmentation, **text classification**,
  lemmatization, morphological analysis, entity linking and more
- Easily extensible with **custom components** and attributes
- Support for custom models in **PyTorch**, **TensorFlow** and other frameworks
- Built in **visualizers** for syntax and NER
- Easy **model packaging**, deployment and workflow management
- Robust, rigorously evaluated accuracy

📖 **For more details, see the
[facts, figures and benchmarks](https://spacy.io/usage/facts-figures).**

## ⏳ Install spaCy

For detailed installation instructions, see the
[documentation](https://spacy.io/usage).

- **Operating system**: macOS / OS X · Linux · Windows (Cygwin, MinGW, Visual
  Studio)
- **Python version**: Python 3.7+ (only 64 bit)
- **Package managers**: [pip] · [conda] (via `conda-forge`)

[pip]: https://pypi.org/project/spacy/
[conda]: https://anaconda.org/conda-forge/spacy

### pip

Using pip, spaCy releases are available as source packages and binary wheels.
Before you install spaCy and its dependencies, make sure that your `pip`,
`setuptools` and `wheel` are up to date.

```bash
pip install -U pip setuptools wheel
pip install spacy
```

To install additional data tables for lemmatization and normalization you can
run `pip install spacy[lookups]` or install
[`spacy-lookups-data`](https://github.com/explosion/spacy-lookups-data)
separately. The lookups package is needed to create blank models with
lemmatization data, and to lemmatize in languages that don't yet come with
pretrained models and aren't powered by third-party libraries.

When using pip it is generally recommended to install packages in a virtual
environment to avoid modifying system state:

```bash
python -m venv .env
source .env/bin/activate
pip install -U pip setuptools wheel
pip install spacy
```

### conda

You can also install spaCy from `conda` via the `conda-forge` channel. For the
feedstock including the build recipe and configuration, check out
[this repository](https://github.com/conda-forge/spacy-feedstock).

```bash
conda install -c conda-forge spacy
```

### Updating spaCy

Some updates to spaCy may require downloading new statistical models. If you're
running spaCy v2.0 or higher, you can use the `validate` command to check if
your installed models are compatible and if not, print details on how to update
them:

```bash
pip install -U spacy
python -m spacy validate
```

If you've trained your own models, keep in mind that your training and runtime
inputs must match. After updating spaCy, we recommend **retraining your models**
with the new version.

📖 **For details on upgrading from spaCy 2.x to spaCy 3.x, see the
[migration guide](https://spacy.io/usage/v3#migrating).**

## 📦 Download model packages

Trained pipelines for spaCy can be installed as **Python packages**. This means
that they're a component of your application, just like any other module. Models
can be installed using spaCy's [`download`](https://spacy.io/api/cli#download)
command, or manually by pointing pip to a path or URL.

| Documentation              |                                                                  |
| -------------------------- | ---------------------------------------------------------------- |
| **[Available Pipelines]**  | Detailed pipeline descriptions, accuracy figures and benchmarks. |
| **[Models Documentation]** | Detailed usage and installation instructions.                    |
| **[Training]**             | How to train your own pipelines on your data.                    |

[available pipelines]: https://spacy.io/models
[models documentation]: https://spacy.io/usage/models
[training]: https://spacy.io/usage/training

```bash
# Download best-matching version of specific model for your spaCy installation
python -m spacy download en_core_web_sm

# pip install .tar.gz archive or .whl from path or URL
pip install /Users/you/en_core_web_sm-3.0.0.tar.gz
pip install /Users/you/en_core_web_sm-3.0.0-py3-none-any.whl
pip install https://github.com/explosion/spacy-models/releases/download/en_core_web_sm-3.0.0/en_core_web_sm-3.0.0.tar.gz
```

### Loading and using models

To load a model, use [`spacy.load()`](https://spacy.io/api/top-level#spacy.load)
with the model name or a path to the model data directory.

```python
import spacy
nlp = spacy.load("en_core_web_sm")
doc = nlp("This is a sentence.")
```

You can also `import` a model directly via its full name and then call its
`load()` method with no arguments.

```python
import spacy
import en_core_web_sm

nlp = en_core_web_sm.load()
doc = nlp("This is a sentence.")
```

📖 **For more info and examples, check out the
[models documentation](https://spacy.io/docs/usage/models).**

## ⚒ Compile from source

The other way to install spaCy is to clone its
[GitHub repository](https://github.com/explosion/spaCy) and build it from
source. That is the common way if you want to make changes to the code base.
You'll need to make sure that you have a development environment consisting of a
Python distribution including header files, a compiler,
[pip](https://pip.pypa.io/en/latest/installing/),
[virtualenv](https://virtualenv.pypa.io/en/latest/) and
[git](https://git-scm.com) installed. The compiler part is the trickiest. How to
do that depends on your system.

| Platform    |                                                                                |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Ubuntu**  | Install system-level dependencies via `apt-get`: `sudo apt-get install build-essential python-dev git` .                                                                                |
| **Mac**     | Install a recent version of [XCode](https://developer.apple.com/xcode/), including the so-called "Command Line Tools". macOS and OS X ship with Python and git preinstalled.                                                                                |
| **Windows** | Install a version of the [Visual C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/) or [Visual Studio Express](https://visualstudio.microsoft.com/vs/express/) that matches the version that was used to compile your Python interpreter. |

For more details and instructions, see the documentation on
[compiling spaCy from source](https://spacy.io/usage#source) and the
[quickstart widget](https://spacy.io/usage#section-quickstart) to get the right
commands for your platform and Python version.

```bash
git clone https://github.com/explosion/spaCy
cd spaCy

python -m venv .env
source .env/bin/activate

# make sure you are using the latest pip
python -m pip install -U pip setuptools wheel

pip install -r requirements.txt
pip install --no-build-isolation --editable .
```

To install with extras:

```bash
pip install --no-build-isolation --editable .[lookups,cuda102]
```

## 🚦 Run tests

spaCy comes with an [extensive test suite](spacy/tests). In order to run the
tests, you'll usually want to clone the repository and build spaCy from source.
This will also install the required development dependencies and test utilities
defined in the [`requirements.txt`](requirements.txt).

Alternatively, you can run `pytest` on the tests from within the installed
`spacy` package. Don't forget to also install the test utilities via spaCy's
[`requirements.txt`](requirements.txt):

```bash
pip install -r requirements.txt
python -m pytest --pyargs spacy
```


# Poetry: Python packaging and dependency management made easy

[![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)](https://python-poetry.org/)
[![Stable Version](https://img.shields.io/pypi/v/poetry?label=stable)][PyPI Releases]
[![Pre-release Version](https://img.shields.io/github/v/release/python-poetry/poetry?label=pre-release&include_prereleases&sort=semver)][PyPI Releases]
[![Python Versions](https://img.shields.io/pypi/pyversions/poetry)][PyPI]
[![Download Stats](https://img.shields.io/pypi/dm/poetry)](https://pypistats.org/packages/poetry)
[![Discord](https://img.shields.io/discord/487711540787675139?logo=discord)][Discord]

Poetry helps you declare, manage and install dependencies of Python projects,
ensuring you have the right stack everywhere.

![Poetry Install](https://raw.githubusercontent.com/python-poetry/poetry/master/assets/install.gif)

Poetry replaces `setup.py`, `requirements.txt`, `setup.cfg`, `MANIFEST.in` and `Pipfile` with a simple `pyproject.toml`
based project format.

```toml
[tool.poetry]
name = "my-package"
version = "0.1.0"
description = "The description of the package"

license = "MIT"

authors = [
    "Sébastien Eustace <sebastien@eustace.io>"
]

repository = "https://github.com/python-poetry/poetry"
homepage = "https://python-poetry.org"

# README file(s) are used as the package description
readme = ["README.md", "LICENSE"]

# Keywords (translated to tags on the package index)
keywords = ["packaging", "poetry"]

[tool.poetry.dependencies]
# Compatible Python versions
python = ">=3.8"
# Standard dependency with semver constraints
aiohttp = "^3.8.1"
# Dependency with extras
requests = { version = "^2.28", extras = ["security"] }
# Version-specific dependencies with prereleases allowed
tomli = { version = "^2.0.1", python = "<3.11", allow-prereleases = true }
# Git dependencies
cleo = { git = "https://github.com/python-poetry/cleo.git", branch = "main" }
# Optional dependencies (installed by extras)
pendulum = { version = "^2.1.2", optional = true }

# Dependency groups are supported for organizing your dependencies
[tool.poetry.group.dev.dependencies]
pytest = "^7.1.2"
pytest-cov = "^3.0"

# ...and can be installed only when explicitly requested
[tool.poetry.group.docs]
optional = true
[tool.poetry.group.docs.dependencies]
Sphinx = "^5.1.1"

# Python-style entrypoints and scripts are easily expressed
[tool.poetry.scripts]
my-script = "my_package:main"
```

## Installation

Poetry supports multiple installation methods, including a simple script found at [install.python-poetry.org]. For full
installation instructions, including advanced usage of the script, alternate install methods, and CI best practices, see
the full [installation documentation].

## Documentation

[Documentation] for the current version of Poetry (as well as the development branch and recently out of support
versions) is available from the [official website].

## Contribute

Poetry is a large, complex project always in need of contributors. For those new to the project, a list of
[suggested issues] to work on in Poetry and poetry-core is available. The full [contributing documentation] also
provides helpful guidance.

## Resources

* [Releases][PyPI Releases]
* [Official Website]
* [Documentation]
* [Issue Tracker]
* [Discord]

  [PyPI]: https://pypi.org/project/poetry/
  [PyPI Releases]: https://pypi.org/project/poetry/#history
  [Official Website]: https://python-poetry.org
  [Documentation]: https://python-poetry.org/docs/
  [Issue Tracker]: https://github.com/python-poetry/poetry/issues
  [Suggested Issues]: https://github.com/python-poetry/poetry/contribute
  [Contributing Documentation]: https://python-poetry.org/docs/contributing
  [Discord]: https://discord.com/invite/awxPgve
  [install.python-poetry.org]: https://install.python-poetry.org
  [Installation Documentation]: https://python-poetry.org/docs/#installation

## Related Projects

* [poetry-core](https://github.com/python-poetry/poetry-core): PEP 517 build-system for Poetry projects, and
dependency-free core functionality of the Poetry frontend
* [poetry-plugin-export](https://github.com/python-poetry/poetry-plugin-export): Export Poetry projects/lock files to
foreign formats like requirements.txt
* [poetry-plugin-bundle](https://github.com/python-poetry/poetry-plugin-bundle): Install Poetry projects/lock files to
external formats like virtual environments
* [install.python-poetry.org](https://github.com/python-poetry/install.python-poetry.org): The official Poetry
installation script
* [website](https://github.com/python-poetry/website): The official Poetry website and blog


# Welcome to Streamlit 👋

**A faster way to build and share data apps.**

## What is Streamlit?

Streamlit lets you transform Python scripts into interactive web apps in minutes, instead of weeks. Build dashboards, generate reports, or create chat apps. Once you’ve created an app, you can use our [Community Cloud platform](https://streamlit.io/cloud) to deploy, manage, and share your app.

### Why choose Streamlit?

- **Simple and Pythonic:** Write beautiful, easy-to-read code.
- **Fast, interactive prototyping:** Let others interact with your data and provide feedback quickly.
- **Live editing:** See your app update instantly as you edit your script.
- **Open-source and free:** Join a vibrant community and contribute to Streamlit's future.

## Installation

Open a terminal and run:

```bash
$ pip install streamlit
$ streamlit hello
```

If this opens our sweet _Streamlit Hello_ app in your browser, you're all set! If not, head over to [our docs](https://docs.streamlit.io/get-started) for specific installs.

The app features a bunch of examples of what you can do with Streamlit. Jump to the [quickstart](#quickstart) section to understand how that all works.

## Quickstart

### A little example

Create a new file `streamlit_app.py` with the following code:
```python
import streamlit as st
x = st.slider("Select a value")
st.write(x, "squared is", x * x)
```

Now run it to open the app!
```
$ streamlit run streamlit_app.py
```

### Give me more!

Streamlit comes in with [a ton of additional powerful elements](https://docs.streamlit.io/develop/api-reference) to spice up your data apps and delight your viewers. Some examples:

    Input widgets
    Dataframes
    Charts
    Layout
    Multi-page apps
    Fun

Our vibrant creators community also extends Streamlit capabilities using  🧩 [Streamlit Components](https://streamlit.io/components).

## Get inspired

There's so much you can build with Streamlit:
- 🤖  [LLMs & chatbot apps](https://streamlit.io/gallery?category=llms)
- 🧬  [Science & technology apps](https://streamlit.io/gallery?category=science-technology)
- 💬  [NLP & language apps](https://streamlit.io/gallery?category=nlp-language)
- 🏦  [Finance & business apps](https://streamlit.io/gallery?category=finance-business)
- 🗺  [Geography & society apps](https://streamlit.io/gallery?category=geography-society)
- and more!

**Check out [our gallery!](https://streamlit.io/gallery)** 🎈

## Community Cloud

Deploy, manage and share your apps for free using our [Community Cloud](https://streamlit.io/cloud)! Sign-up [here](https://share.streamlit.io/signup).

## Resources
- Explore our [docs](https://docs.streamlit.io) to learn how Streamlit works.
- Ask questions and get help in our [community forum](https://discuss.streamlit.io).
- Read our [blog](https://blog.streamlit.io) for tips from developers and creators.
- Extend Streamlit's capabilities by installing or creating your own [Streamlit Components](https://streamlit.io/components).
- Help others find and play with your app by using the Streamlit GitHub badge in your repository:
```markdown
[![Streamlit App](https://static.streamlit.io/badges/streamlit_badge_black_white.svg)](URL_TO_YOUR_APP)
```
[![Streamlit App](https://static.streamlit.io/badges/streamlit_badge_black_white.svg)](https://share.streamlit.io/streamlit/roadmap)

## License

Streamlit is completely free and open-source and licensed under the [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) license.


*Faker* is a Python package that generates fake data for you. Whether
you need to bootstrap your database, create good-looking XML documents,
fill-in your persistence to stress test it, or anonymize data taken from
a production service, Faker is for you.

Faker is heavily inspired by `PHP Faker`_, `Perl Faker`_, and by `Ruby Faker`_.

----

::

    _|_|_|_|          _|
    _|        _|_|_|  _|  _|      _|_|    _|  _|_|
    _|_|_|  _|    _|  _|_|      _|_|_|_|  _|_|
    _|      _|    _|  _|  _|    _|        _|
    _|        _|_|_|  _|    _|    _|_|_|  _|

|pypi| |build| |coverage| |license|

----

Compatibility
-------------

Starting from version ``4.0.0``, ``Faker`` dropped support for Python 2 and from version ``5.0.0``
only supports Python 3.7 and above. If you still need Python 2 compatibility, please install version ``3.0.1`` in the
meantime, and please consider updating your codebase to support Python 3 so you can enjoy the
latest features ``Faker`` has to offer. Please see the `extended docs`_ for more details, especially
if you are upgrading from version ``2.0.4`` and below as there might be breaking changes.

This package was also previously called ``fake-factory`` which was already deprecated by the end
of 2016, and much has changed since then, so please ensure that your project and its dependencies
do not depend on the old package.

Basic Usage
-----------

Install with pip:

.. code:: bash

    pip install Faker

Use ``faker.Faker()`` to create and initialize a faker
generator, which can generate data by accessing properties named after
the type of data you want.

.. code:: python

    from faker import Faker
    fake = Faker()

    fake.name()
    # 'Lucy Cechtelar'

    fake.address()
    # '426 Jordy Lodge
    #  Cartwrightshire, SC 88120-6700'

    fake.text()
    # 'Sint velit eveniet. Rerum atque repellat voluptatem quia rerum. Numquam excepturi
    #  beatae sint laudantium consequatur. Magni occaecati itaque sint et sit tempore. Nesciunt
    #  amet quidem. Iusto deleniti cum autem ad quia aperiam.
    #  A consectetur quos aliquam. In iste aliquid et aut similique suscipit. Consequatur qui
    #  quaerat iste minus hic expedita. Consequuntur error magni et laboriosam. Aut aspernatur
    #  voluptatem sit aliquam. Dolores voluptatum est.
    #  Aut molestias et maxime. Fugit autem facilis quos vero. Eius quibusdam possimus est.
    #  Ea quaerat et quisquam. Deleniti sunt quam. Adipisci consequatur id in occaecati.
    #  Et sint et. Ut ducimus quod nemo ab voluptatum.'

Each call to method ``fake.name()`` yields a different (random) result.
This is because faker forwards ``faker.Generator.method_name()`` calls
to ``faker.Generator.format(method_name)``.

.. code:: python

    for _ in range(10):
      print(fake.name())

    # 'Adaline Reichel'
    # 'Dr. Santa Prosacco DVM'
    # 'Noemy Vandervort V'
    # 'Lexi O'Conner'
    # 'Gracie Weber'
    # 'Roscoe Johns'
    # 'Emmett Lebsack'
    # 'Keegan Thiel'
    # 'Wellington Koelpin II'
    # 'Ms. Karley Kiehn V'

Pytest fixtures
---------------

``Faker`` also has its own ``pytest`` plugin which provides a ``faker`` fixture you can use in your
tests. Please check out the `pytest fixture docs` to learn more.

Providers
---------

Each of the generator properties (like ``name``, ``address``, and
``lorem``) are called "fake". A faker generator has many of them,
packaged in "providers".

.. code:: python

    from faker import Faker
    from faker.providers import internet

    fake = Faker()
    fake.add_provider(internet)

    print(fake.ipv4_private())

Check the `extended docs`_ for a list of `bundled providers`_ and a list of
`community providers`_.

Localization
------------

``faker.Faker`` can take a locale as an argument, to return localized
data. If no localized provider is found, the factory falls back to the
default LCID string for US english, ie: ``en_US``.

.. code:: python

    from faker import Faker
    fake = Faker('it_IT')
    for _ in range(10):
        print(fake.name())

    # 'Elda Palumbo'
    # 'Pacifico Giordano'
    # 'Sig. Avide Guerra'
    # 'Yago Amato'
    # 'Eustachio Messina'
    # 'Dott. Violante Lombardo'
    # 'Sig. Alighieri Monti'
    # 'Costanzo Costa'
    # 'Nazzareno Barbieri'
    # 'Max Coppola'

``faker.Faker`` also supports multiple locales. New in v3.0.0.

.. code:: python

    from faker import Faker
    fake = Faker(['it_IT', 'en_US', 'ja_JP'])
    for _ in range(10):
        print(fake.name())

    # 鈴木 陽一
    # Leslie Moreno
    # Emma Williams
    # 渡辺 裕美子
    # Marcantonio Galuppi
    # Martha Davis
    # Kristen Turner
    # 中津川 春香
    # Ashley Castillo
    # 山田 桃子

You can check available Faker locales in the source code, under the
providers package. The localization of Faker is an ongoing process, for
which we need your help. Please don't hesitate to create a localized
provider for your own locale and submit a Pull Request (PR).

Optimizations
-------------
The Faker constructor takes a performance-related argument called
``use_weighting``. It specifies whether to attempt to have the frequency
of values match real-world frequencies (e.g. the English name Gary would
be much more frequent than the name Lorimer). If ``use_weighting`` is ``False``,
then all items have an equal chance of being selected, and the selection
process is much faster. The default is ``True``.

Command line usage
------------------

When installed, you can invoke faker from the command-line:

.. code:: console

    faker [-h] [--version] [-o output]
          [-l {bg_BG,cs_CZ,...,zh_CN,zh_TW}]
          [-r REPEAT] [-s SEP]
          [-i {package.containing.custom_provider otherpkg.containing.custom_provider}]
          [fake] [fake argument [fake argument ...]]

Where:

-  ``faker``: is the script when installed in your environment, in
   development you could use ``python -m faker`` instead

-  ``-h``, ``--help``: shows a help message

-  ``--version``: shows the program's version number

-  ``-o FILENAME``: redirects the output to the specified filename

-  ``-l {bg_BG,cs_CZ,...,zh_CN,zh_TW}``: allows use of a localized
   provider

-  ``-r REPEAT``: will generate a specified number of outputs

-  ``-s SEP``: will generate the specified separator after each
   generated output

-  ``-i {my.custom_provider other.custom_provider}`` list of additional custom
   providers to use. Note that is the import path of the package containing
   your Provider class, not the custom Provider class itself.

-  ``fake``: is the name of the fake to generate an output for, such as
   ``name``, ``address``, or ``text``

-  ``[fake argument ...]``: optional arguments to pass to the fake (e.g. the
   profile fake takes an optional list of comma separated field names as the
   first argument)

Examples:

.. code:: console

    $ faker address
    968 Bahringer Garden Apt. 722
    Kristinaland, NJ 09890

    $ faker -l de_DE address
    Samira-Niemeier-Allee 56
    94812 Biedenkopf

    $ faker profile ssn,birthdate
    {'ssn': '628-10-1085', 'birthdate': '2008-03-29'}

    $ faker -r=3 -s=";" name
    Willam Kertzmann;
    Josiah Maggio;
    Gayla Schmitt;

How to create a Provider
------------------------

.. code:: python

    from faker import Faker
    fake = Faker()

    # first, import a similar Provider or use the default one
    from faker.providers import BaseProvider

    # create new provider class
    class MyProvider(BaseProvider):
        def foo(self) -> str:
            return 'bar'

    # then add new provider to faker instance
    fake.add_provider(MyProvider)

    # now you can use:
    fake.foo()
    # 'bar'

How to create a Dynamic Provider
--------------------------------

Dynamic providers can read elements from an external source.

.. code:: python

    from faker import Faker
    from faker.providers import DynamicProvider

    medical_professions_provider = DynamicProvider(
         provider_name="medical_profession",
         elements=["dr.", "doctor", "nurse", "surgeon", "clerk"],
    )

    fake = Faker()

    # then add new provider to faker instance
    fake.add_provider(medical_professions_provider)

    # now you can use:
    fake.medical_profession()
    # 'dr.'

How to customize the Lorem Provider
-----------------------------------

You can provide your own sets of words if you don't want to use the
default lorem ipsum one. The following example shows how to do it with a list of words picked from `cakeipsum <http://www.cupcakeipsum.com/>`__ :

.. code:: python

    from faker import Faker
    fake = Faker()

    my_word_list = [
    'danish','cheesecake','sugar',
    'Lollipop','wafer','Gummies',
    'sesame','Jelly','beans',
    'pie','bar','Ice','oat' ]

    fake.sentence()
    # 'Expedita at beatae voluptatibus nulla omnis.'

    fake.sentence(ext_word_list=my_word_list)
    # 'Oat beans oat Lollipop bar cheesecake.'

How to use with Factory Boy
---------------------------

`Factory Boy` already ships with integration with ``Faker``. Simply use the
``factory.Faker`` method of ``factory_boy``:

.. code:: python

    import factory
    from myapp.models import Book

    class BookFactory(factory.Factory):
        class Meta:
            model = Book

        title = factory.Faker('sentence', nb_words=4)
        author_name = factory.Faker('name')

Accessing the `random` instance
-------------------------------

The ``.random`` property on the generator returns the instance of
``random.Random`` used to generate the values:

.. code:: python

    from faker import Faker
    fake = Faker()
    fake.random
    fake.random.getstate()

By default all generators share the same instance of ``random.Random``, which
can be accessed with ``from faker.generator import random``. Using this may
be useful for plugins that want to affect all faker instances.

Unique values
-------------

Through use of the ``.unique`` property on the generator, you can guarantee
that any generated values are unique for this specific instance.

.. code:: python

   from faker import Faker
   fake = Faker()
   names = [fake.unique.first_name() for i in range(500)]
   assert len(set(names)) == len(names)

Calling ``fake.unique.clear()`` clears the already seen values.
Note, to avoid infinite loops, after a number of attempts to find a unique
value, Faker will throw a ``UniquenessException``. Beware of the `birthday
paradox <https://en.wikipedia.org/wiki/Birthday_problem>`_, collisions
are more likely than you'd think.

.. code:: python

   from faker import Faker

   fake = Faker()
   for i in range(3):
        # Raises a UniquenessException
        fake.unique.boolean()

In addition, only hashable arguments and return values can be used
with ``.unique``.

Seeding the Generator
---------------------

When using Faker for unit testing, you will often want to generate the same
data set. For convenience, the generator also provides a ``seed()`` method,
which seeds the shared random number generator. A Seed produces the same result
when the same methods with the same version of faker are called.

.. code:: python

    from faker import Faker
    fake = Faker()
    Faker.seed(4321)

    print(fake.name())
    # 'Margaret Boehm'

Each generator can also be switched to use its own instance of ``random.Random``,
separated from the shared one, by using the ``seed_instance()`` method, which acts
the same way. For example:

.. code:: python

    from faker import Faker
    fake = Faker()
    fake.seed_instance(4321)

    print(fake.name())
    # 'Margaret Boehm'

Please note that as we keep updating datasets, results are not guaranteed to be
consistent across patch versions. If you hardcode results in your test, make sure
you pinned the version of ``Faker`` down to the patch number.

If you are using ``pytest``, you can seed the ``faker`` fixture by defining a ``faker_seed``
fixture. Please check out the `pytest fixture docs` to learn more.

Tests
-----

Run tests:

.. code:: bash

    $ tox

Write documentation for the providers of the default locale:

.. code:: bash

    $ python -m faker > docs.txt

Write documentation for the providers of a specific locale:

.. code:: bash

    $ python -m faker --lang=de_DE > docs_de.txt

Contribute
----------

Please see `CONTRIBUTING`_.

License
-------

Faker is released under the MIT License. See the bundled `LICENSE`_ file
for details.

Credits
-------

-  `FZaninotto`_ / `PHP Faker`_
-  `Distribute`_
-  `Buildout`_
-  `modern-package-template`_

.. _FZaninotto: https://github.com/fzaninotto
.. _PHP Faker: https://github.com/fzaninotto/Faker
.. _Perl Faker: http://search.cpan.org/~jasonk/Data-Faker-0.07/
.. _Ruby Faker: https://github.com/stympy/faker
.. _Distribute: https://pypi.org/project/distribute/
.. _Buildout: http://www.buildout.org/
.. _modern-package-template: https://pypi.org/project/modern-package-template/
.. _extended docs: https://faker.readthedocs.io/en/stable/
.. _bundled providers: https://faker.readthedocs.io/en/stable/providers.html
.. _community providers: https://faker.readthedocs.io/en/stable/communityproviders.html
.. _pytest fixture docs: https://faker.readthedocs.io/en/master/pytest-fixtures.html
.. _LICENSE: https://github.com/joke2k/faker/blob/master/LICENSE.txt
.. _CONTRIBUTING: https://github.com/joke2k/faker/blob/master/CONTRIBUTING.rst
.. _Factory Boy: https://github.com/FactoryBoy/factory_boy

.. |pypi| image:: https://img.shields.io/pypi/v/Faker.svg?style=flat-square&label=version
    :target: https://pypi.org/project/Faker/
    :alt: Latest version released on PyPI

.. |coverage| image:: https://img.shields.io/coveralls/joke2k/faker/master.svg?style=flat-square
    :target: https://coveralls.io/r/joke2k/faker?branch=master
    :alt: Test coverage

.. |build| image:: https://github.com/joke2k/faker/actions/workflows/ci.yml/badge.svg
    :target: https://github.com/joke2k/faker/actions/workflows/ci.yml
    :alt: Build status of the master branch

.. |license| image:: https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square
    :target: https://raw.githubusercontent.com/joke2k/faker/master/LICENSE.txt
    :alt: Package license