GuessIt

https://guessit-io.github.io/guessit/
Admin
GuessIt is a Python library that intelligently extracts metadata from video filenames, including...
Tokens:4,386
Snippets:60
Trust Score:9.7
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install GuessIt from Source

Source: https://guessit-io.github.io/guessit/sources

Install GuessIt into your Python environment's site-packages folder using setup.py.

```bash
$ python setup.py install

```

--------------------------------

### Install GuessIt via pip

Source: https://guessit-io.github.io/guessit

Install the library using the Python package manager.

```bash
pip install guessit
```

--------------------------------

### Develop GuessIt from Source

Source: https://guessit-io.github.io/guessit/sources

Use this command to install GuessIt directly from the source folder for development purposes.

```bash
$ python setup.py develop

```

--------------------------------

### Advanced Output with guessit CLI

Source: https://guessit-io.github.io/guessit/migration

The command-line interface with the `-a` or `--advanced` flag provides detailed match information, including raw values, start and end positions, and type. This output may display duplicates that are merged in standard output.

```bash
$ guessit "Treme.1x03.Right.Place,.Wrong.Time.HDTV.XviD-NoTV.avi" -a
For: Treme.1x03.Right.Place,.Wrong.Time.HDTV.XviD-NoTV.avi
GuessIt found: {
    "title": {
        "value": "Treme",
        "raw": "Treme.",
        "start": 0,
        "end": 6
    },
    "season": {
        "value": 1,
        "raw": "1",
        "start": 6,
        "end": 7
    },
    "episode": {
        "value": 3,
        "raw": "03",
        "start": 8,
        "end": 10
    },
    "episode_title": {
        "value": "Right Place, Wrong Time",
        "raw": ".Right.Place,.Wrong.Time.",
        "start": 10,
        "end": 35
    },
    "format": {
        "value": "HDTV",
        "raw": "HDTV",
        "start": 35,
        "end": 39
    },
    "video_codec": {
        "value": "XviD",
        "raw": "XviD",
        "start": 40,
        "end": 44
    },
    "release_group": {
        "value": "NoTV",
        "raw": "-NoTV",
        "start": 44,
        "end": 49
    },
    "container": {
        "value": "avi",
        "raw": ".avi",
        "start": 49,
        "end": 53
    },
    "mimetype": {
        "value": "video/x-msvideo",
        "start": 53,
        "end": 53
    },
    "type": {
        "value": "episode",
        "start": 53,
        "end": 53
    }
}
```

--------------------------------

### CLI Usage

Source: https://guessit-io.github.io/guessit

The GuessIt command-line interface allows users to parse filenames or release names to extract metadata.

```APIDOC
## CLI guessit

### Description
Parses a filename or release name to extract media information.

### Method
CLI Command

### Parameters
#### Positional Arguments
- **filename** (string) - Optional - Filename or release name to guess

#### Optional Arguments
- **-t, --type** (string) - Optional - The suggested file type: movie, episode.
- **-L, --allowed-languages** (string) - Optional - Allowed language (can be used multiple times).
- **-C, --allowed-countries** (string) - Optional - Allowed country (can be used multiple times).
- **-T, --expected-title** (string) - Optional - Expected title to parse (can be used multiple times).
- **-G, --expected-group** (string) - Optional - Expected release group (can be used multiple times).
- **-j, --json** (flag) - Optional - Display information for filename guesses as json output.
- **-y, --yaml** (flag) - Optional - Display information for filename guesses as yaml output.
```

--------------------------------

### Download GuessIt Zipball

Source: https://guessit-io.github.io/guessit/sources

Download the GuessIt source code as a compressed zipball from GitHub.

```bash
$ curl -L https://github.com/guessit-io/guessit/zipball/master -o guessit.zip

```

--------------------------------

### Download GuessIt Tarball

Source: https://guessit-io.github.io/guessit/sources

Download the GuessIt source code as a compressed tarball from GitHub.

```bash
$ curl -L https://github.com/guessit-io/guessit/tarball/master -o guessit.tar.gz

```

--------------------------------

### Clone GuessIt Repository

Source: https://guessit-io.github.io/guessit/sources

Use this command to clone the public GuessIt repository from GitHub.

```bash
$ git clone https://github.com/guessit-io/guessit.git

```

--------------------------------

### GuessIt Command-Line Usage

Source: https://guessit-io.github.io/guessit

The command-line interface for GuessIt provides numerous options for parsing filenames and controlling output. Use this for direct file parsing from the terminal.

```bash
usage: guessit [-h] [-t TYPE] [-n] [-Y] [-D] [-L ALLOWED_LANGUAGES]
               [-C ALLOWED_COUNTRIES] [-E] [-T EXPECTED_TITLE]
               [-G EXPECTED_GROUP] [--includes INCLUDES] [--excludes EXCLUDES]
               [-f INPUT_FILE] [-v] [-P SHOW_PROPERTY] [-a] [-s] [-l] [-j]
               [-y] [-i] [-c CONFIG] [--no-user-config] [--no-default-config]
               [-p] [-V] [--version]
               [filename [filename ...]]

positional arguments:
  filename              Filename or release name to guess

optional arguments:
  -h, --help            show this help message and exit

Naming:
  -t TYPE, --type TYPE  The suggested file type: movie, episode. If undefined,
                        type will be guessed.
  -n, --name-only       Parse files as name only, considering "/" and "\" like
                        other separators.
  -Y, --date-year-first
                        If short date is found, consider the first digits as
                        the year.
  -D, --date-day-first  If short date is found, consider the second digits as
                        the day.
  -L ALLOWED_LANGUAGES, --allowed-languages ALLOWED_LANGUAGES
                        Allowed language (can be used multiple times)
  -C ALLOWED_COUNTRIES, --allowed-countries ALLOWED_COUNTRIES
                        Allowed country (can be used multiple times)
  -E, --episode-prefer-number
                        Guess "serie.213.avi" as the episode 213. Without this
                        option, it will be guessed as season 2, episode 13
  -T EXPECTED_TITLE, --expected-title EXPECTED_TITLE
                        Expected title to parse (can be used multiple times)
  -G EXPECTED_GROUP, --expected-group EXPECTED_GROUP
                        Expected release group (can be used multiple times)
  --includes INCLUDES   List of properties to be detected
  --excludes EXCLUDES   List of properties to be ignored

Input:
  -f INPUT_FILE, --input-file INPUT_FILE
                        Read filenames from an input text file. File should
                        use UTF-8 charset.

Output:
  -v, --verbose         Display debug output
  -P SHOW_PROPERTY, --show-property SHOW_PROPERTY
                        Display the value of a single property (title, series, 
                        video_codec, year, ...)
  -a, --advanced        Display advanced information for filename guesses, as
                        json output
  -s, --single-value    Keep only first value found for each property
  -l, --enforce-list    Wrap each found value in a list even when property has
                        a single value
  -j, --json            Display information for filename guesses as json
                        output
  -y, --yaml            Display information for filename guesses as yaml
                        output
  -i, --output-input-string
                        Add input_string property in the output

Configuration:
  -c CONFIG, --config CONFIG
                        Filepath to configuration file. Configuration file
                        contains the same options as those from command line
                        options, but option names have "-" characters replaced
                        with "_". This configuration will be merged with
                        default and user configuration files.
  --no-user-config      Disable user configuration. If not defined, guessit
                        tries to read configuration files at
                        ~/.guessit/options.(json|yml|yaml) and
                        ~/.config/guessit/options.(json|yml|yaml)
  --no-default-config   Disable default configuration. This should be done
                        only if you are providing a full configuration through
                        user configuration or --config option. If no
                        "advanced_config" is provided by another configuration
                        file, it will still be loaded from default
                        configuration.

Information:
  -p, --properties      Display properties that can be guessed.
  -V, --values          Display property values that can be guessed.
  --version             Display the guessit version.
```

--------------------------------

### Extract metadata from a filename

Source: https://guessit-io.github.io/guessit

Use the guessit command-line tool to parse video file information.

```bash
$ guessit "Treme.1x03.Right.Place,.Wrong.Time.HDTV.XviD-NoTV.avi"
For: Treme.1x03.Right.Place,.Wrong.Time.HDTV.XviD-NoTV.avi
GuessIt found: {
    "title": "Treme",
    "season": 1,
    "episode": 3,
    "episode_title": "Right Place, Wrong Time",
    "source": "HDTV",
    "video_codec": "Xvid",
    "release_group": "NoTV",
    "container": "avi",
    "mimetype": "video/x-msvideo",
    "type": "episode"
}
```

--------------------------------

### Python Module Usage

Source: https://guessit-io.github.io/guessit

GuessIt can be imported as a Python module to parse filenames programmatically.

```APIDOC
## Python guessit.guessit

### Description
Parses a filename string and returns a MatchesDict containing the extracted metadata.

### Request Example
from guessit import guessit
guessit('Treme.1x03.Right.Place,.Wrong.Time.HDTV.XviD-NoTV.avi')

### Response
MatchesDict([('title', 'Treme'), ('season', 1), ('episode', 3), ('episode_title', 'Right Place, Wrong Time'), ('source', 'HDTV'), ('video_codec', 'Xvid'), ('release_group', 'NoTV'), ('container', 'avi'), ('mimetype', 'video/x-msvideo'), ('type', 'episode')])
```

--------------------------------

### Guess Video Information using guessit API

Source: https://guessit-io.github.io/guessit/migration

Use the `guessit` function to parse video file information. This replaces older functions like `guess_video_info`. The output is a `MatchesDict` which preserves the order of matches.

```python
>>> from guessit import guessit
>>> guessit('Treme.1x03.Right.Place,.Wrong.Time.HDTV.XviD-NoTV.avi')
MatchesDict([('title', 'Treme'), ('season', 1), ('episode', 3), ('episode_title', 'Right Place, Wrong Time'), ('format', 'HDTV'), ('video_codec', 'XviD'), ('release_group', 'NoTV'), ('container', 'avi'), ('mimetype', 'video/x-msvideo'), ('type', 'episode')])
```

--------------------------------

### GuessIt Python Module Usage

Source: https://guessit-io.github.io/guessit

Integrate GuessIt into your Python projects by importing the `guessit` function. This allows programmatic parsing of filenames.

```python
from guessit import guessit
guessit('Treme.1x03.Right.Place,.Wrong.Time.HDTV.XviD-NoTV.avi')
# MatchesDict([('title', 'Treme'), ('season', 1), ('episode', 3), ('episode_title', 'Right Place, Wrong Time'), ('source', 'HDTV'), ('video_codec', 'Xvid'), ('release_group', 'NoTV'), ('container', 'avi'), ('mimetype', 'video/x-msvideo'), ('type', 'episode')])
```
Tokens:
Raw