1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
|
# parse-torrent-name
[](https://godoc.org/github.com/middelink/go-parse-torrent-name)
[](https://github.com/middelink/go-parse-torrent-name/blob/master/LICENSE)
[](https://travis-ci.org/middelink/go-parse-torrent-name)
[](https://coveralls.io/github/middelink/go-parse-torrent-name?branch=master)
[](https://goreportcard.com/report/github.com/middelink/go-parse-torrent-name)
> Extract media information from torrent-like filename
A Go port of [Jānis](https://github.com/jzjzjzj)' awesome
[library](https://github.com/jzjzjzj/parse-torrent-name) written in
javascript.
Extract all possible media information present in filenames. Multiple regex
rules are applied on filename string each of which extracts correponding
information from the filename. If a regex rule matches, the corresponding part
is removed from the filename. In the end, the remaining part is taken as the
title of the content.
## Why?
Online APIs by providers like
[TMDb](https://www.themoviedb.org/documentation/api),
[TVDb](http://thetvdb.com/wiki/index.php?title=Programmers_API) and
[OMDb](http://www.omdbapi.com/) don't react to well to search
queries which include any kind of extra information. To get proper results from
these APIs, only the title of the content should be provided as the search
query where this library comes into play. The accuracy of the results can be
improved by passing in the year which can also be extracted using this library.
## Usage
```go
import PTN
info = PTN.parse('A freakishly cool movie or TV episode')
print info # All details that were parsed
```
PTN works well for both movies and TV episodes. All meaningful information is
extracted and returned together in a dictionary. The text which could not be
parsed is returned in the `excess` field.
### Movies
```py
PTN.parse('San Andreas 2015 720p WEB-DL x264 AAC-JYK')
# {
# 'group': 'JYK',
# 'title': 'San Andreas',
# 'resolution': '720p',
# 'codec': 'x264',
# 'year': '2015',
# 'audio': 'AAC',
# 'quality': 'WEB-DL'
# }
PTN.parse('The Martian 2015 540p HDRip KORSUB x264 AAC2 0-FGT')
# {
# 'group': '0-FGT',
# 'title': 'The Martian',
# 'resolution': '540p',
# 'excess': ['KORSUB', '2'],
# 'codec': 'x264',
# 'year': 2015,
# 'audio': 'AAC',
# 'quality': 'HDRip'
# }
```
### TV episodes
```py
PTN.parse('Mr Robot S01E05 HDTV x264-KILLERS[ettv]')
# {
# 'episode': 5,
# 'season': 1,
# 'title': 'Mr Robot',
# 'codec': 'x264',
# 'group': 'KILLERS[ettv]'
# 'quality': 'HDTV'
# }
PTN.parse('friends.s02e01.720p.bluray-sujaidr')
# {
# 'episode': 1,
# 'season': 2,
# 'title': 'friends',
# 'resolution': '720p',
# 'group': 'sujaidr',
# 'quality': 'bluray'
# }
```
### Note
PTN does not garantee the fields `group`, `excess` and `episodeName` as these
fields might be interchanged with each other. This shoudn't affect most
applications since episode name can be fetched from an online database
after getting the season and episode number correctly.
### Parts extracted
- audio
- codec
- container
- episode
- episodeName
- excess
- extended
- garbage
- group
- hardcoded
- language
- proper
- quality
- region
- repack
- resolution
- season
- title
- website
- widescreen
- year
## Install
### Automatic
PTN can be installed using `go get`.
```sh
$ go get github.com/middelink/go-parse-torrent-name
```
### Manual
First clone the repository.
```sh
$ git clone https://github.com/middelink/go-parse-torrent-name PTN && cd PTN
```
And run the command for installing the package.
```sh
$ go install .
```
## Contributing
Take a look at the open
[issues](https://github.com/jzjzjzj/parse-torrent-name/issues) on the original
project and submit a PR!
## License
MIT © [Pauline Middelink](http://www.polyware.nl/~middelink)
|
