Skip to content

Commit 706a0bd

Browse files
matcornicmatcornic
committed
feat: init first version
0 parents  commit 706a0bd

File tree

10 files changed

+634
-0
lines changed

10 files changed

+634
-0
lines changed

‎.gitignore‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Compiled Object files, Static and Dynamic libs (Shared Objects)
2+
*.o
3+
*.a
4+
*.so
5+
6+
# Folders
7+
_obj
8+
_test
9+
10+
# Architecture specific extensions/prefixes
11+
*.[568vq]
12+
[568vq].out
13+
14+
*.cgo1.go
15+
*.cgo2.c
16+
_cgo_defun.c
17+
_cgo_gotypes.go
18+
_cgo_export.*
19+
20+
_testmain.go
21+
22+
*.exe
23+
*.test
24+
*.prof

‎LICENCE.txt‎

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright 2016 Mathieu Cornic
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎README.md‎

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
# Subify
2+
Subify is a tool to download subtitles for your favorite TV shows and movies.
3+
It is directly able to open the video with your default player, once the subtitle is downloaded.
4+
5+
Subify uses [SubDB Web API](http://thesubdb.com/) to get subtitles. It also considers that you use a default player interpreting srt subtitles when the video file name is the same than the srt file (ex: [VLC](http://www.videolan.org/vlc/)).
6+
7+
## Installing
8+
Download the last version of the Subify : xxx (Works on Unix, Mac OS and Windows)
9+
10+
If you have Golang, you can get Subify and its binary with :
11+
```shell
12+
go get -v github.com/matcornic/subify
13+
```
14+
15+
You may want to create a Service Automator with Mac OS in order to add a "Subify" option in the Finder menu for your videos. Then, you will be able to do "Right click > Subify", and enjoy your video
16+
17+
## Get started
18+
Note : the binary is usable as is, but ensure to add Subify to your PATH environment variable, to run the command from anywhere on your OS.
19+
20+
```shell
21+
# Download subtitle with default language
22+
subify dl <path_to_your_video>
23+
# Download subtitle with default language, and open video with your default player
24+
subify dl <path_to_your_video> -o
25+
# Download subtitle with french language, and open with your default player
26+
subify dl <path_to_your_video> -o -l fr
27+
```
28+
29+
## Documentation
30+
### Global usage
31+
```
32+
Tool to handle subtitles for your best TV Shows and movies
33+
34+
Usage:
35+
subify [command]
36+
37+
Available Commands:
38+
dl Download the subtitles for your video - 'subify dl --help'
39+
40+
Flags:
41+
--config string Config file (default is $HOME/.subify.json). Build a file like this to change default behaviour
42+
--dev Instanciate development sandbox instead of production variables
43+
-h, --help help for subify
44+
-v, --verbose Print more information while executing
45+
46+
Use "subify [command] --help" for more information about a command.
47+
```
48+
49+
### Downloading command
50+
```
51+
Download the subtitles for your video (movie or TV Shows)
52+
Give the path of your video as first parameter and let's go !
53+
54+
Usage:
55+
subify dl <video-path> [flags]
56+
57+
Aliases:
58+
dl, download
59+
60+
61+
Flags:
62+
-l, --language string Language of the subtitle (default "en")
63+
-o, --open Once the subtitle is donwloaded, open the video with your default video player
64+
65+
Global Flags:
66+
--config string Config file (default is $HOME/.subify.json). Build a file like this to change default behaviour
67+
--dev Instanciate development sandbox instead of production variables
68+
-v, --verbose Print more information while executing
69+
```
70+
71+
## Release Notes
72+
* **0.1.0** Jan 15, 2016
73+
* Implement firs init
74+
75+
## Contributing
76+
1. Fork it
77+
2. Create your feature branch (git checkout -b my-new-feature)
78+
3. Commit your changes (git commit -am 'Add some feature')
79+
4. Push to the branch (git push origin my-new-feature)
80+
5. Create new Pull Request
81+
82+
## TODO
83+
1. List of favorite languages (Downloads the first to match)
84+
2. Auto update command
85+
3. Upload command to contribute to SubDB database
86+
87+
## License
88+
Subify is released under the Apache 2.0 license. See LICENSE.txt

‎cmd/dl.go‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
package cmd
2+
3+
import (
4+
"fmt"
5+
"github.com/matcornic/subify/common/config"
6+
"github.com/matcornic/subify/common/utils"
7+
"github.com/matcornic/subify/subtitles"
8+
"github.com/skratchdot/open-golang/open"
9+
"github.com/spf13/cobra"
10+
"github.com/spf13/viper"
11+
"strings"
12+
)
13+
14+
var language string
15+
var openVideo bool
16+
17+
// dlCmd represents the dl command
18+
var dlCmd = &cobra.Command{
19+
Use: "dl <video-path>",
20+
Aliases: []string{"download"},
21+
Short: "Download the subtitles for your video - 'subify dl --help'",
22+
Long: `Download the subtitles for your video (movie or TV Shows)
23+
Give the path of your video as first parameter and let's go !`,
24+
Run: func(cmd *cobra.Command, args []string) {
25+
// Assertions
26+
if config.Verbose {
27+
fmt.Println("Downloading command called with following parameters : " + strings.Join(args, " "))
28+
}
29+
if len(args) != 1 {
30+
utils.Exit("Video file needed. See usage : 'subify help' or 'subify dl --help'")
31+
}
32+
33+
videoPath := args[0]
34+
subtitles.Download(videoPath)
35+
36+
if openVideo {
37+
open.Run(videoPath)
38+
}
39+
},
40+
}
41+
42+
func init() {
43+
dlCmd.Flags().StringVarP(&language, "language", "l", "en", "Language of the subtitle")
44+
viper.BindPFlag("language", dlCmd.Flags().Lookup("language"))
45+
dlCmd.Flags().BoolVarP(&openVideo, "open", "o", false, "Once the subtitle is donwloaded, open the video with your default video player")
46+
RootCmd.AddCommand(dlCmd)
47+
}

0 commit comments

Comments
 (0)