Skip to content

Commit f86ed02

Browse files
committed
Add: README file
1 parent c61098a commit f86ed02

File tree

1 file changed

+69
-0
lines changed

1 file changed

+69
-0
lines changed

README.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
2+
# Subscene (unofficial) API
3+
4+
RESTful API for [Subscene](http://subscene.com).
5+
Currently being used by [Popcorn Time](https://github.com/andy-pham/popcorn-app).
6+
Feel free to fork and contribute.
7+
8+
Demo: <http://subscene-api.appspot.com/>
9+
10+
11+
## Retrieve Subtitles
12+
13+
### Request:
14+
15+
```
16+
GET http://subscene-api.appspot.com/subtitles/{imdb_id}
17+
```
18+
19+
```
20+
GET http://subscene-api.appspot.com/subtitles/{imdb_id_1}-{imdb_id_2}-...
21+
```
22+
23+
### Parameters:
24+
25+
- `imdb_id`: The IMDb ID of the movie.
26+
27+
### Examples:
28+
29+
- <http://subscene-api.appspot.com/subtitles/tt0435705>
30+
- <http://subscene-api.appspot.com/subtitles/tt0770828-tt0816442-tt0903624>
31+
32+
33+
## Quick Start
34+
35+
1. Install the [App Engine Python SDK](https://developers.google.com/appengine/downloads).
36+
2. Clone this repo:
37+
38+
```
39+
git clone [email protected]:andy-pham/subscene-api.git
40+
```
41+
42+
3. Run locally from the command line:
43+
44+
```
45+
cd subscene-api
46+
dev_appserver.py .
47+
```
48+
49+
Visit subscene-api <http://localhost:8080/>
50+
51+
The admin console is viewable at <http://localhost:8000/>
52+
53+
54+
# Deploy
55+
56+
To deploy subscene-api to App Engine
57+
58+
1. Use the [Admin Console](https://appengine.google.com/) to create a project/app id.
59+
2. Deploy:
60+
61+
```
62+
appcfg.py -A <your-project-id> --oauth2 update .
63+
```
64+
65+
subscene-api should be visible at <http://your-app-id.appspot.com/>
66+
67+
# License
68+
69+
Licensed under the [MIT License](http://cheeaun.mit-license.org/).

0 commit comments

Comments
 (0)