1GUESSIT(1)                          GuessIt                         GUESSIT(1)
2
3
4

NAME

6       guessit  -  GuessIt  Documentation  Latest  VersionLGPLv3  LicenseBuild
7       StatusCoveralls
8
9       GuessIt is a python library that extracts as much information as possi‐
10       ble from a video filename.
11
12       It  has  a very powerful matcher that allows to guess properties from a
13       video using its filename only.  This matcher works with both movies and
14       tv shows episodes.
15
16       For example, GuessIt can do the following:
17
18          $ guessit "Treme.1x03.Right.Place,.Wrong.Time.HDTV.XviD-NoTV.avi"
19          For: Treme.1x03.Right.Place,.Wrong.Time.HDTV.XviD-NoTV.avi
20          GuessIt found: {
21              "title": "Treme",
22              "season": 1,
23              "episode": 3,
24              "episode_title": "Right Place, Wrong Time",
25              "source": "HDTV",
26              "video_codec": "XviD",
27              "release_group": "NoTV",
28              "container": "avi",
29              "mimetype": "video/x-msvideo",
30              "type": "episode"
31          }
32

MIGRATION NOTE

34       In  GuessIt 3, some properties and values were renamed in order to keep
35       consistency and to be more intuitive.
36
37       To migrate from guessit 2.x to guessit 3.x, please read  the  migration
38       page.   To  migrate from guessit 0.x or 1.x to guessit 2.x, please read
39       the migration page.
40

INSTALL

42       Installing GuessIt is simple with pip:
43
44          $ pip install guessit
45
46       You can also install from sources.
47

USAGE

49       GuessIt can be used from command line:
50
51          $ guessit
52          usage: guessit [-h] [-t TYPE] [-n] [-Y] [-D] [-L ALLOWED_LANGUAGES]
53                         [-C ALLOWED_COUNTRIES] [-E] [-T EXPECTED_TITLE]
54                         [-G EXPECTED_GROUP] [--includes INCLUDES]
55                         [--excludes EXCLUDES] [-f INPUT_FILE] [-v]
56                         [-P SHOW_PROPERTY] [-a] [-s] [-l] [-j] [-y] [-c CONFIG]
57                         [--no-user-config] [--no-default-config] [-p] [-V]
58                         [--version]
59                         [filename [filename ...]]
60
61          positional arguments:
62            filename              Filename or release name to guess
63
64          optional arguments:
65            -h, --help            show this help message and exit
66
67          Naming:
68            -t TYPE, --type TYPE  The suggested file type: movie, episode. If undefined,
69                                  type will be guessed.
70            -n, --name-only       Parse files as name only, considering "/" and "\" like
71                                  other separators.
72            -Y, --date-year-first
73                                  If short date is found, consider the first digits as
74                                  the year.
75            -D, --date-day-first  If short date is found, consider the second digits as
76                                  the day.
77            -L ALLOWED_LANGUAGES, --allowed-languages ALLOWED_LANGUAGES
78                                  Allowed language (can be used multiple times)
79            -C ALLOWED_COUNTRIES, --allowed-countries ALLOWED_COUNTRIES
80                                  Allowed country (can be used multiple times)
81            -E, --episode-prefer-number
82                                  Guess "serie.213.avi" as the episode 213. Without this
83                                  option, it will be guessed as season 2, episode 13
84            -T EXPECTED_TITLE, --expected-title EXPECTED_TITLE
85                                  Expected title to parse (can be used multiple times)
86            -G EXPECTED_GROUP, --expected-group EXPECTED_GROUP
87                                  Expected release group (can be used multiple times)
88            --includes INCLUDES   List of properties to be detected
89            --excludes EXCLUDES   List of properties to be ignored
90
91          Input:
92            -f INPUT_FILE, --input-file INPUT_FILE
93                                  Read filenames from an input text file. File should
94                                  use UTF-8 charset.
95
96          Output:
97            -v, --verbose         Display debug output
98            -P SHOW_PROPERTY, --show-property SHOW_PROPERTY
99                                  Display the value of a single property (title, series,
100                                  video_codec, year, ...)
101            -a, --advanced        Display advanced information for filename guesses, as
102                                  json output
103            -s, --single-value    Keep only first value found for each property
104            -l, --enforce-list    Wrap each found value in a list even when property has
105                                  a single value
106            -j, --json            Display information for filename guesses as json
107                                  output
108            -y, --yaml            Display information for filename guesses as yaml
109                                  output
110
111          Configuration:
112            -c CONFIG, --config CONFIG
113                                  Filepath to configuration file. Configuration file
114                                  contains the same options as those from command line
115                                  options, but option names have "-" characters replaced
116                                  with "_". This configuration will be merged with
117                                  default and user configuration files.
118            --no-user-config      Disable user configuration. If not defined, guessit
119                                  tries to read configuration files at
120                                  ~/.guessit/options.(json|yml|yaml) and
121                                  ~/.config/guessit/options.(json|yml|yaml)
122            --no-default-config   Disable default configuration. This should be done
123                                  only if you are providing a full configuration through
124                                  user configuration or --config option.
125
126          Information:
127            -p, --properties      Display properties that can be guessed.
128            -V, --values          Display property values that can be guessed.
129            --version             Display the guessit version.
130
131       It can also be used as a python module:
132
133          >>> from guessit import guessit
134          >>> guessit('Treme.1x03.Right.Place,.Wrong.Time.HDTV.XviD-NoTV.avi')
135          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')])
136
137       MatchesDict is a dict that keeps matches ordering.
138
139       Command line options can be given as dict or string to the second argu‐
140       ment.
141

CONFIGURATION

143       Find more about Guessit configuration at configuration page.
144

REST API

146       A REST API will be available soon ...
147
148       Sources are available in a dedicated guessit-rest repository.
149

SUPPORT

151       This  project  is  hosted  on GitHub. Feel free to open an issue if you
152       think you have found a bug or something is missing in guessit.
153
154       GuessIt relies on Rebulk project for pattern and rules registration.
155

LICENSE

157       GuessIt is licensed under the LGPLv3 license.
158

AUTHOR

160       Remi Alvergnat
161
163       2020, Remi Alvergnat
164
165
166
167
1683.1.0                            Jan 30, 2020                       GUESSIT(1)
Impressum