simple-justwatch-python-api 0.14__tar.gz → 0.15__tar.gz

{simple-justwatch-python-api-0.14 → simple_justwatch_python_api-0.15}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: simple-justwatch-python-api
-Version: 0.14
+Version: 0.15
 Summary: A simple JustWatch Python API
 Author-email: Electronic Mango <78230210+Electronic-Mango@users.noreply.github.com>
 License:                     GNU GENERAL PUBLIC LICENSE
@@ -715,6 +715,7 @@ A simple unofficial JustWatch Python API which uses [`GraphQL`](https://graphql.
   * [Details](#details)
   * [Offers for countries](#offers-for-countries)
 * [Return data structures](#return-data-structures)
+* [Locale, language, country](#locale-language-country)
 * [Disclaimer](#disclaimer)
 
 
@@ -760,10 +761,10 @@ Only the first argument is required, it specifies a title to search.
 | 4 | `count`     | `int`  | NO       | `4`           | Up to how many entries should be returned              |
 | 5 | `best_only` | `bool` | NO       | `True`        | Determines whether only best offers should be returned |
 
-`country` must be 2-letter code, e.g. `US`, `GB`, `FR`.
+`country` must be **ISO 3166-1 alpha-2** 2-letter code , e.g. `US`, `GB`, `FR`.
 It should be uppercase, however lowercase codes are automatically converted to uppercase.
 
-`language` is also 2-letter code, lowercase, e.g. `en`, `fr`.
+`language` is a **ISO 639-1** (usually) 2-letter code, lowercase, e.g. `en`, `fr`.
 
 `count` determines **up to** how many entries should be returned.
 If JustWatch GraphQL API returns fewer entries, then this function will also return fewer values.
@@ -792,11 +793,11 @@ results = details("nodeID", "US", "en", False)
 
 Only the first argument is required - the node ID of element to look up details for.
 
-|   | Argument    | Type   | Required | Default value | Description                                           |
-|---|-------------|--------|----------|---------------|-------------------------------------------------------|
-| 1 | `node_id`   | `str`  | **YES**  | -             | Node ID to look up                                    |
-| 2 | `country`   | `str`  | NO       | `"US"`        | Country to search for offers                          |
-| 3 | `language`  | `str`  | NO       | `"en"`        | Language of responses                                 |
+|   | Argument    | Type   | Required | Default value | Description                                            |
+|---|-------------|--------|----------|---------------|--------------------------------------------------------|
+| 1 | `node_id`   | `str`  | **YES**  | -             | Node ID to look up                                     |
+| 2 | `country`   | `str`  | NO       | `"US"`        | Country to search for offers                           |
+| 3 | `language`  | `str`  | NO       | `"en"`        | Language of responses                                  |
 | 5 | `best_only` | `bool` | NO       | `True`        | Determines whether only best offers should be returned |
 
 General usage of these arguments matches the [`search`](#search) command.
@@ -821,13 +822,13 @@ results = offers_for_countries("nodeID", {"US", "UK", "CA"}, "en", True)
 First two arguments are required - node ID, and set of countries.
 
 |   | Argument    | Type       | Required | Default value | Description                                            |
-|---|-------------|------------|:---------|--------------|--------------------------------------------------------|
-| 1 | `node_id`   | `str`      | **YES**  | -            | Node ID to look up                                     |
-| 2 | `countries` | `set[str]` | **YES**  | -            | Set of countries to look up offers for                 |
-| 3 | `language`  | `str`      | NO       | `"en"`       | Language of responses                                  |
-| 5 | `best_only` | `bool`     | NO       | `True`       | Determines whether only best offers should be returned |
+|---|-------------|------------|:---------|---------------|--------------------------------------------------------|
+| 1 | `node_id`   | `str`      | **YES**  | -             | Node ID to look up                                     |
+| 2 | `countries` | `set[str]` | **YES**  | -             | Set of countries to look up offers for                 |
+| 3 | `language`  | `str`      | NO       | `"en"`        | Language of responses                                  |
+| 5 | `best_only` | `bool`     | NO       | `True`        | Determines whether only best offers should be returned |
 
-Usage `language` and `best_only` arguments matches the [`search`](#search) command.
+Usage of `language` and `best_only` arguments matches the [`search`](#search) command.
 
 Returned value `dict[str, list[Offer]]`, where key is country given as argument and value is a list of [`Offer`](#return-data-structures) tuples.
 
@@ -841,6 +842,22 @@ Detailed descriptions of all used data structures are available in the [document
 
 
 
+## Locale, language, country
+
+Languages and countries are configured via ISO standard.
+Countries are following **ISO 3166-1 alpha-2** standard (2-letter codes, uppercase).
+Languages are following **ISO 639-1** standard (usually 2-letter codes, lowercase).
+
+Language codes can also be country-specific, e.g. `es-MX` for Mexican Spanish, etc.
+The country part **must** be uppercase.
+
+There is a list of supported locales in [JustWatch **REST API** documentation](https://apis.justwatch.com/docs/api/#tips).
+Any combination of those languages and countries should work with this API as well.
+
+If you provide unsupported language JustWatch API should default to english.
+
+
+
 ## Disclaimer
 
 This API is in no way affiliated, associated, authorized, endorsed by, or in any way officially connected with JustWatch.

{simple-justwatch-python-api-0.14 → simple_justwatch_python_api-0.15}/README.md

@@ -20,6 +20,7 @@ A simple unofficial JustWatch Python API which uses [`GraphQL`](https://graphql.
   * [Details](#details)
   * [Offers for countries](#offers-for-countries)
 * [Return data structures](#return-data-structures)
+* [Locale, language, country](#locale-language-country)
 * [Disclaimer](#disclaimer)
 
 
@@ -65,10 +66,10 @@ Only the first argument is required, it specifies a title to search.
 | 4 | `count`     | `int`  | NO       | `4`           | Up to how many entries should be returned              |
 | 5 | `best_only` | `bool` | NO       | `True`        | Determines whether only best offers should be returned |
 
-`country` must be 2-letter code, e.g. `US`, `GB`, `FR`.
+`country` must be **ISO 3166-1 alpha-2** 2-letter code , e.g. `US`, `GB`, `FR`.
 It should be uppercase, however lowercase codes are automatically converted to uppercase.
 
-`language` is also 2-letter code, lowercase, e.g. `en`, `fr`.
+`language` is a **ISO 639-1** (usually) 2-letter code, lowercase, e.g. `en`, `fr`.
 
 `count` determines **up to** how many entries should be returned.
 If JustWatch GraphQL API returns fewer entries, then this function will also return fewer values.
@@ -97,11 +98,11 @@ results = details("nodeID", "US", "en", False)
 
 Only the first argument is required - the node ID of element to look up details for.
 
-|   | Argument    | Type   | Required | Default value | Description                                           |
-|---|-------------|--------|----------|---------------|-------------------------------------------------------|
-| 1 | `node_id`   | `str`  | **YES**  | -             | Node ID to look up                                    |
-| 2 | `country`   | `str`  | NO       | `"US"`        | Country to search for offers                          |
-| 3 | `language`  | `str`  | NO       | `"en"`        | Language of responses                                 |
+|   | Argument    | Type   | Required | Default value | Description                                            |
+|---|-------------|--------|----------|---------------|--------------------------------------------------------|
+| 1 | `node_id`   | `str`  | **YES**  | -             | Node ID to look up                                     |
+| 2 | `country`   | `str`  | NO       | `"US"`        | Country to search for offers                           |
+| 3 | `language`  | `str`  | NO       | `"en"`        | Language of responses                                  |
 | 5 | `best_only` | `bool` | NO       | `True`        | Determines whether only best offers should be returned |
 
 General usage of these arguments matches the [`search`](#search) command.
@@ -126,13 +127,13 @@ results = offers_for_countries("nodeID", {"US", "UK", "CA"}, "en", True)
 First two arguments are required - node ID, and set of countries.
 
 |   | Argument    | Type       | Required | Default value | Description                                            |
-|---|-------------|------------|:---------|--------------|--------------------------------------------------------|
-| 1 | `node_id`   | `str`      | **YES**  | -            | Node ID to look up                                     |
-| 2 | `countries` | `set[str]` | **YES**  | -            | Set of countries to look up offers for                 |
-| 3 | `language`  | `str`      | NO       | `"en"`       | Language of responses                                  |
-| 5 | `best_only` | `bool`     | NO       | `True`       | Determines whether only best offers should be returned |
+|---|-------------|------------|:---------|---------------|--------------------------------------------------------|
+| 1 | `node_id`   | `str`      | **YES**  | -             | Node ID to look up                                     |
+| 2 | `countries` | `set[str]` | **YES**  | -             | Set of countries to look up offers for                 |
+| 3 | `language`  | `str`      | NO       | `"en"`        | Language of responses                                  |
+| 5 | `best_only` | `bool`     | NO       | `True`        | Determines whether only best offers should be returned |
 
-Usage `language` and `best_only` arguments matches the [`search`](#search) command.
+Usage of `language` and `best_only` arguments matches the [`search`](#search) command.
 
 Returned value `dict[str, list[Offer]]`, where key is country given as argument and value is a list of [`Offer`](#return-data-structures) tuples.
 
@@ -146,6 +147,22 @@ Detailed descriptions of all used data structures are available in the [document
 
 
 
+## Locale, language, country
+
+Languages and countries are configured via ISO standard.
+Countries are following **ISO 3166-1 alpha-2** standard (2-letter codes, uppercase).
+Languages are following **ISO 639-1** standard (usually 2-letter codes, lowercase).
+
+Language codes can also be country-specific, e.g. `es-MX` for Mexican Spanish, etc.
+The country part **must** be uppercase.
+
+There is a list of supported locales in [JustWatch **REST API** documentation](https://apis.justwatch.com/docs/api/#tips).
+Any combination of those languages and countries should work with this API as well.
+
+If you provide unsupported language JustWatch API should default to english.
+
+
+
 ## Disclaimer
 
 This API is in no way affiliated, associated, authorized, endorsed by, or in any way officially connected with JustWatch.

{simple-justwatch-python-api-0.14 → simple_justwatch_python_api-0.15}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "simple-justwatch-python-api"
 authors = [{name = "Electronic Mango", email = "78230210+Electronic-Mango@users.noreply.github.com"}]
-version = "0.14"
+version = "0.15"
 description="A simple JustWatch Python API"
 readme = "README.md"
 license = {file = "LICENSE"}

{simple-justwatch-python-api-0.14 → simple_justwatch_python_api-0.15}/src/simple_justwatch_python_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: simple-justwatch-python-api
-Version: 0.14
+Version: 0.15
 Summary: A simple JustWatch Python API
 Author-email: Electronic Mango <78230210+Electronic-Mango@users.noreply.github.com>
 License:                     GNU GENERAL PUBLIC LICENSE
@@ -715,6 +715,7 @@ A simple unofficial JustWatch Python API which uses [`GraphQL`](https://graphql.
   * [Details](#details)
   * [Offers for countries](#offers-for-countries)
 * [Return data structures](#return-data-structures)
+* [Locale, language, country](#locale-language-country)
 * [Disclaimer](#disclaimer)
 
 
@@ -760,10 +761,10 @@ Only the first argument is required, it specifies a title to search.
 | 4 | `count`     | `int`  | NO       | `4`           | Up to how many entries should be returned              |
 | 5 | `best_only` | `bool` | NO       | `True`        | Determines whether only best offers should be returned |
 
-`country` must be 2-letter code, e.g. `US`, `GB`, `FR`.
+`country` must be **ISO 3166-1 alpha-2** 2-letter code , e.g. `US`, `GB`, `FR`.
 It should be uppercase, however lowercase codes are automatically converted to uppercase.
 
-`language` is also 2-letter code, lowercase, e.g. `en`, `fr`.
+`language` is a **ISO 639-1** (usually) 2-letter code, lowercase, e.g. `en`, `fr`.
 
 `count` determines **up to** how many entries should be returned.
 If JustWatch GraphQL API returns fewer entries, then this function will also return fewer values.
@@ -792,11 +793,11 @@ results = details("nodeID", "US", "en", False)
 
 Only the first argument is required - the node ID of element to look up details for.
 
-|   | Argument    | Type   | Required | Default value | Description                                           |
-|---|-------------|--------|----------|---------------|-------------------------------------------------------|
-| 1 | `node_id`   | `str`  | **YES**  | -             | Node ID to look up                                    |
-| 2 | `country`   | `str`  | NO       | `"US"`        | Country to search for offers                          |
-| 3 | `language`  | `str`  | NO       | `"en"`        | Language of responses                                 |
+|   | Argument    | Type   | Required | Default value | Description                                            |
+|---|-------------|--------|----------|---------------|--------------------------------------------------------|
+| 1 | `node_id`   | `str`  | **YES**  | -             | Node ID to look up                                     |
+| 2 | `country`   | `str`  | NO       | `"US"`        | Country to search for offers                           |
+| 3 | `language`  | `str`  | NO       | `"en"`        | Language of responses                                  |
 | 5 | `best_only` | `bool` | NO       | `True`        | Determines whether only best offers should be returned |
 
 General usage of these arguments matches the [`search`](#search) command.
@@ -821,13 +822,13 @@ results = offers_for_countries("nodeID", {"US", "UK", "CA"}, "en", True)
 First two arguments are required - node ID, and set of countries.
 
 |   | Argument    | Type       | Required | Default value | Description                                            |
-|---|-------------|------------|:---------|--------------|--------------------------------------------------------|
-| 1 | `node_id`   | `str`      | **YES**  | -            | Node ID to look up                                     |
-| 2 | `countries` | `set[str]` | **YES**  | -            | Set of countries to look up offers for                 |
-| 3 | `language`  | `str`      | NO       | `"en"`       | Language of responses                                  |
-| 5 | `best_only` | `bool`     | NO       | `True`       | Determines whether only best offers should be returned |
+|---|-------------|------------|:---------|---------------|--------------------------------------------------------|
+| 1 | `node_id`   | `str`      | **YES**  | -             | Node ID to look up                                     |
+| 2 | `countries` | `set[str]` | **YES**  | -             | Set of countries to look up offers for                 |
+| 3 | `language`  | `str`      | NO       | `"en"`        | Language of responses                                  |
+| 5 | `best_only` | `bool`     | NO       | `True`        | Determines whether only best offers should be returned |
 
-Usage `language` and `best_only` arguments matches the [`search`](#search) command.
+Usage of `language` and `best_only` arguments matches the [`search`](#search) command.
 
 Returned value `dict[str, list[Offer]]`, where key is country given as argument and value is a list of [`Offer`](#return-data-structures) tuples.
 
@@ -841,6 +842,22 @@ Detailed descriptions of all used data structures are available in the [document
 
 
 
+## Locale, language, country
+
+Languages and countries are configured via ISO standard.
+Countries are following **ISO 3166-1 alpha-2** standard (2-letter codes, uppercase).
+Languages are following **ISO 639-1** standard (usually 2-letter codes, lowercase).
+
+Language codes can also be country-specific, e.g. `es-MX` for Mexican Spanish, etc.
+The country part **must** be uppercase.
+
+There is a list of supported locales in [JustWatch **REST API** documentation](https://apis.justwatch.com/docs/api/#tips).
+Any combination of those languages and countries should work with this API as well.
+
+If you provide unsupported language JustWatch API should default to english.
+
+
+
 ## Disclaimer
 
 This API is in no way affiliated, associated, authorized, endorsed by, or in any way officially connected with JustWatch.

simple_justwatch_python_api-0.15/src/simplejustwatchapi/main.py

@@ -0,0 +1,33 @@
+from itertools import product
+
+from justwatch import details, offers_for_countries, search
+
+
+from dataclasses import dataclass
+
+
+@dataclass
+class Base:
+    base_field_1: int
+    base_field_2: int
+
+
+@dataclass
+class Child(Base):
+    child_field_1: int
+
+
+def main():
+    obj = Child(1, 2, 3)
+    # result = details("ts4")  # Breaking Bad
+    # result = details("tss25")  # Breaking Bad S5
+    # result = details("tse411")  # Breaking Bad S5E1
+    # result = details("tm10")  # The Matrix
+    result = details("ts20711")  # The Simpsons
+    # result = search("The Simpsons")
+    print(result)
+    print()
+
+
+if __name__ == "__main__":
+    main()

{simple-justwatch-python-api-0.14 → simple_justwatch_python_api-0.15}/src/simplejustwatchapi/query.py

@@ -92,6 +92,7 @@ fragment TitleDetails on MovieOrShow {
     }
     externalIds {
       imdbId
+      tmdbId
       __typename
     }
     posterUrl(profile: $profile, format: $formatPoster)
@@ -201,7 +202,7 @@ class Offer(NamedTuple):
     url: str
     """URL to this offer."""
 
-    element_count: int
+    element_count: int | None
     """Element count, usually 0."""
 
     available_to: str | None
@@ -259,6 +260,9 @@ class MediaEntry(NamedTuple):
     imdb_id: str | None
     """ID of this entry in IMDB."""
 
+    tmdb_id: str | None
+    """ID of this entry in TMDB."""
+
     poster: str | None
     """URL to poster for this ID."""
 
@@ -469,6 +473,7 @@ def _parse_entry(json: any) -> MediaEntry:
     genres = [node.get("shortName") for node in content.get("genres", []) if node]
     external_ids = content.get("externalIds")
     imdb_id = external_ids.get("imdbId") if external_ids else None
+    tmdb_id = external_ids.get("tmdbId") if external_ids else None
     poster_url_field = content.get("posterUrl")
     poster = _IMAGES_URL + poster_url_field if poster_url_field else None
     backdrops = [_IMAGES_URL + bd.get("backdropUrl") for bd in content.get("backdrops", []) if bd]
@@ -485,6 +490,7 @@ def _parse_entry(json: any) -> MediaEntry:
         short_description,
         genres,
         imdb_id,
+        tmdb_id,
         poster,
         backdrops,
         offers,
@@ -502,7 +508,7 @@ def _parse_offer(json: any) -> Offer:
     type = json.get("type")
     package = _parse_package(json["package"])
     url = json.get("standardWebURL")
-    element_count = json.get("elementCount", 0)
+    element_count = json.get("elementCount")
     available_to = json.get("availableTo")
     deeplink_roku = json.get("deeplinkRoku")
     subtitle_languages = json.get("subtitleLanguages")

simple-justwatch-python-api-0.14/src/simplejustwatchapi/main.py

@@ -1,21 +0,0 @@
-from justwatch import details, offers_for_countries, search
-from query import MediaEntry, Offer, OfferPackage
-
-
-def main():
-    response = search("The Matrix", "US", "en", 3, True)
-    print(response)
-    print()
-
-    response = details("tm10", "US", "en", False)
-    print(response)
-    print()
-
-    response = offers_for_countries("tm10", {"US", "GB", "FR"}, "en", True)
-    print(response)
-    print()
-
-
-
-if __name__ == "__main__":
-    main()