You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-17Lines changed: 17 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -46,7 +46,7 @@ This Python API has 3 functions:
46
46
47
47
Detailed documentation is available in https://electronic-mango.github.io/simple-justwatch-python-api/.
48
48
49
-
Example outputs from all commands are in [`examples/`](examples/) directory.
49
+
Example outputs from all functions are in [`examples/`](examples/) directory.
50
50
51
51
52
52
### Search
@@ -83,16 +83,16 @@ Returned value is a list of [`MediaEntry`](#return-data-structures) objects.
83
83
84
84
For very large searches (high `count` value) I recommend using default `best_only=True` to avoid issues with [request complexity](#request-complexity).
85
85
86
-
Example command and its output is in [`examples/search_output.py`](examples/search_output.py).
86
+
Example function call and its output is in [`examples/search_output.py`](examples/search_output.py).
87
87
88
88
89
89
### Details
90
90
91
91
Details function allows for looking up details for a single entry via its node ID.
92
-
Node ID can be taken from output of the [`search`](#search)command.
92
+
Node ID can be taken from output of the [`search`](#search)function.
93
93
94
-
Output from this function contains the same data as a single entry from the [`search`](#search)command.
95
-
There's no reason to first use the [`search`](#search)command, then use node ID from one of entries for this command.
94
+
Output from this function contains the same data as a single entry from the [`search`](#search)function.
95
+
There's no reason to first use the [`search`](#search)function, then use node ID from one of entries for this function.
96
96
97
97
```python
98
98
from simplejustwatchapi.justwatch import details
@@ -109,7 +109,7 @@ Only the first argument is required - the node ID of element to look up details
109
109
| 3 |`language`|`str`| NO |`"en"`| Language of responses |
110
110
| 5 |`best_only`|`bool`| NO |`True`| Determines whether only best offers should be returned |
111
111
112
-
General usage of these arguments matches the [`search`](#search)command.
112
+
General usage of these arguments matches the [`search`](#search)function.
113
113
114
114
Returned value is a single [`MediaEntry`](#return-data-structures) object.
115
115
@@ -121,20 +121,20 @@ Some fields are specific for one of the media types and will be `None` for other
121
121
-`episode_number` is present only for episodes
122
122
-`age_certification` is present only for movies and shows
123
123
124
-
For episodes specifically most of the fields will be empty (which is why [`episodes`](#episodes)command returns different structure).
124
+
For episodes specifically most of the fields will be empty (which is why [`episodes`](#episodes)function returns different structure).
125
125
126
-
Example command and its output is in [`examples/details_output.py`](examples/details_output.py).
126
+
Example function call and its output is in [`examples/details_output.py`](examples/details_output.py).
127
127
128
128
129
129
### Seasons
130
130
131
131
Seasons function allows for looking up all seasons of a show via its node ID.
132
-
Node/show ID can be taken from output of the [`search`](#search)command.
133
-
It's also the same ID as input for [`details`](#details)command.
132
+
Node/show ID can be taken from output of the [`search`](#search)function.
133
+
It's also the same ID as input for [`details`](#details)function.
134
134
135
-
Each season contains similar data to the [`details`](#details)command, with additional season number and number of episodes.
135
+
Each season contains similar data to the [`details`](#details)function, with additional season number and number of episodes.
136
136
137
-
Usage also matches [`details`](#details)command:
137
+
Usage also matches [`details`](#details)function:
138
138
```python
139
139
from simplejustwatchapi.justwatch import seasons
140
140
@@ -156,9 +156,9 @@ Returned value is a list of [`MediaEntry`](#return-data-structures) objects, eac
156
156
### Episodes
157
157
158
158
Episodes function allows for looking up all episodes of a season via season's node ID.
159
-
Node/season ID can be taken from output of the [`seasons`](#seasons)command.
159
+
Node/season ID can be taken from output of the [`seasons`](#seasons)function.
160
160
161
-
Usage matches [`details`](#details)command:
161
+
Usage matches [`details`](#details)function:
162
162
```python
163
163
from simplejustwatchapi.justwatch import seasons
164
164
@@ -200,11 +200,11 @@ First two arguments are required - node ID, and set of countries.
200
200
| 3 |`language`|`str`| NO |`"en"`| Language of responses |
201
201
| 5 |`best_only`|`bool`| NO |`True`| Determines whether only best offers should be returned |
202
202
203
-
Usage of `language` and `best_only` arguments matches the [`search`](#search)command.
203
+
Usage of `language` and `best_only` arguments matches the [`search`](#search)function.
204
204
205
205
Returned value `dict[str, list[Offer]]`, where key is country given as argument and value is a list of [`Offer`](#return-data-structures) tuples.
206
206
207
-
Example command and its output is in [`examples/offers_for_countries_output.py`](examples/offers_for_countries_output.py).
207
+
Example function call and its output is in [`examples/offers_for_countries_output.py`](examples/offers_for_countries_output.py).
208
208
209
209
210
210
@@ -219,7 +219,7 @@ Some fields are specific for one of the media types and will be `None` for other
219
219
-`episode_number` is present only for episodes
220
220
-`age_certification` is present only for movies and shows
221
221
222
-
For episodes specifically most of the fields will be empty (which is why [`episodes`](#episodes)command returns different structure).
222
+
For episodes specifically most of the fields will be empty (which is why [`episodes`](#episodes)function returns different structure).
223
223
224
224
As [`search`](#search) function can return only movies and shows the episode-specific and season-specific fields will always be `None`,
225
225
but are included in `MediaEntry` so they will be present in output from [`details`](#details) function.
0 commit comments