| Name | filmot JSON |
| Version |
0.0.3
JSON |
| download |
| home_page | |
| Summary | filmot.com API |
| upload_time | 2024-02-08 19:29:21 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.7 |
| license | The MIT License Copyright (c) 2023-present Omer Duskin Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
filmot
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Filmot API Wrapper
Filmot API Wrapper is a Python package that provides easy programmatically access to the
[Filmot.com](https://filmot.com/) search engine. It simplifies searching YouTube videos by words in subtitles,
fetching channel statistics, and historical data.
## Prerequisites
Before using the Filmot API Wrapper, you'll need a RapidAPI account and to register to the Filmot app at:
[Filmot RapidAPI](https://rapidapi.com/Jopik1/api/filmot-tube-metadata-archive/).
## Installation
You can install the package using `pip` directly from PyPI or by cloning the repository from GitHub.
**Install from PyPI:**
```bash
pip install filmot
```
**Install from GitHub (latest development version):**
```bash
pip install git+ssh://git@github.com/dusking/filmot.git --upgrade
```
## Usage
Using this wrapper is straightforward.
It follows the filmot API documentation closely and converts responses into Python objects.
Here's an example of how to use it:
```python
from filmot import Filmot
# Optional: Set your RapidAPI key in the config so you won't need to provide it in the usage.
Filmot.set_rapidapi_key("***")
# Initialize the Filmot client
filmot = Filmot()
# Search in YouTube archive
response = filmot.search("Spill The Beans", limit=3)
# Response holds the first 3 results
print(response)
[<SearchResponse "Spill The Beans"-Gct3b0yoabU>,
<SearchResponse "Spill The Beans"-Gct3b0yoabU>,
<SearchResponse "Spill The Beans"-ZViO1Gnp2xA>]
# Get the hit count of the first response
first_response = response[0]
print(first_response.hit_count())
# Get the query hits for first response
first_response.hits_data()
[{'link': 'https://www.youtube.com/watch?v=Gct3b0yoabU&t=771.92s',
'text': "when the beans are ready we're going to Spill the Beans later on in the day okay later on in the day we're going to spill the uh"},
{'link': 'https://www.youtube.com/watch?v=Gct3b0yoabU&t=11058.16s',
'text': 'the chat right now we have a lot of gases Spill the Beans everybody can we get some Spill the Beans emojis on the chat going you know this is how we do it'},
{'link': 'https://www.youtube.com/watch?v=Gct3b0yoabU&t=11060.68s',
'text': 'gases Spill the Beans everybody can we get some Spill the Beans emojis on the chat going you know this is how we do it here on LA flights we always have to'},
{'link': 'https://www.youtube.com/watch?v=Gct3b0yoabU&t=11071.96s',
'text': "beans we have to stir the beans and once the beans are ready then we'll Spill the Beans pretty cool announcement I I think it's cool"},
{'link': 'https://www.youtube.com/watch?v=Gct3b0yoabU&t=13874.88s',
'text': "whenever we do cross 35 we're going to Spill the Beans okay and I I promise you you're not going to be disappointed at the"},
{'link': 'https://www.youtube.com/watch?v=Gct3b0yoabU&t=16073.399s',
'text': "happen and we already have the dates get ready can we get the Spill the Beans emji going can we stir the beans yeah believe it or not if you're"},
{'link': 'https://www.youtube.com/watch?v=Gct3b0yoabU&t=16088.159s',
'text': "Emoji right custom made that you can use during a live show and it says Spill the Beans okay so first part LA flights goes to New York we're going to be visiting"},
{'link': 'https://www.youtube.com/watch?v=Gct3b0yoabU&t=16130.439s',
'text': "else I was going to be a zombie uh let's see are we going to have The Spill the Beans emojis let's say yes we have Cheryl sending five memberships by the"}]
# Convert the response to a Python dictionary
response_dict = first_response.to_dict()
print(response_dict)
# Convert the response to JSON format
response_json = first_response.to_json()
print(response_json)
```
Here's another simple example:
```python
from filmot import Categories, Countries, Language
# Adjust the search query
response = filmot.search("Spill The Beans",
category=Categories.GAMING,
country=Countries.UNITED_STATES,
language=Language.ENGLISH,
limit=3)
```
With this wrapper, accessing Filmot.com API becomes easy and intuitive.
Happy coding!
Raw data
{
"_id": null,
"home_page": "",
"name": "filmot",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "filmot",
"author": "",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/81/89/79906740edd370c12f454b8b650380d513ddda437fdca0e76055cae5270f/filmot-0.0.3.tar.gz",
"platform": null,
"description": "# Filmot API Wrapper\n\n\n\n\n\nFilmot API Wrapper is a Python package that provides easy programmatically access to the\n[Filmot.com](https://filmot.com/) search engine. It simplifies searching YouTube videos by words in subtitles,\nfetching channel statistics, and historical data.\n\n## Prerequisites\n\nBefore using the Filmot API Wrapper, you'll need a RapidAPI account and to register to the Filmot app at:\n[Filmot RapidAPI](https://rapidapi.com/Jopik1/api/filmot-tube-metadata-archive/).\n\n## Installation\n\nYou can install the package using `pip` directly from PyPI or by cloning the repository from GitHub.\n\n**Install from PyPI:**\n\n```bash\npip install filmot\n```\n\n**Install from GitHub (latest development version):**\n\n```bash\npip install git+ssh://git@github.com/dusking/filmot.git --upgrade\n```\n\n## Usage\n\nUsing this wrapper is straightforward.\nIt follows the filmot API documentation closely and converts responses into Python objects.\nHere's an example of how to use it:\n\n```python\nfrom filmot import Filmot\n\n# Optional: Set your RapidAPI key in the config so you won't need to provide it in the usage.\nFilmot.set_rapidapi_key(\"***\")\n\n# Initialize the Filmot client\nfilmot = Filmot()\n\n# Search in YouTube archive\nresponse = filmot.search(\"Spill The Beans\", limit=3)\n\n# Response holds the first 3 results\nprint(response)\n[<SearchResponse \"Spill The Beans\"-Gct3b0yoabU>,\n <SearchResponse \"Spill The Beans\"-Gct3b0yoabU>,\n <SearchResponse \"Spill The Beans\"-ZViO1Gnp2xA>]\n\n# Get the hit count of the first response\nfirst_response = response[0]\nprint(first_response.hit_count())\n\n# Get the query hits for first response\nfirst_response.hits_data()\n[{'link': 'https://www.youtube.com/watch?v=Gct3b0yoabU&t=771.92s',\n 'text': \"when the beans are ready we're going to Spill the Beans later on in the day okay later on in the day we're going to spill the uh\"},\n {'link': 'https://www.youtube.com/watch?v=Gct3b0yoabU&t=11058.16s',\n 'text': 'the chat right now we have a lot of gases Spill the Beans everybody can we get some Spill the Beans emojis on the chat going you know this is how we do it'},\n {'link': 'https://www.youtube.com/watch?v=Gct3b0yoabU&t=11060.68s',\n 'text': 'gases Spill the Beans everybody can we get some Spill the Beans emojis on the chat going you know this is how we do it here on LA flights we always have to'},\n {'link': 'https://www.youtube.com/watch?v=Gct3b0yoabU&t=11071.96s',\n 'text': \"beans we have to stir the beans and once the beans are ready then we'll Spill the Beans pretty cool announcement I I think it's cool\"},\n {'link': 'https://www.youtube.com/watch?v=Gct3b0yoabU&t=13874.88s',\n 'text': \"whenever we do cross 35 we're going to Spill the Beans okay and I I promise you you're not going to be disappointed at the\"},\n {'link': 'https://www.youtube.com/watch?v=Gct3b0yoabU&t=16073.399s',\n 'text': \"happen and we already have the dates get ready can we get the Spill the Beans emji going can we stir the beans yeah believe it or not if you're\"},\n {'link': 'https://www.youtube.com/watch?v=Gct3b0yoabU&t=16088.159s',\n 'text': \"Emoji right custom made that you can use during a live show and it says Spill the Beans okay so first part LA flights goes to New York we're going to be visiting\"},\n {'link': 'https://www.youtube.com/watch?v=Gct3b0yoabU&t=16130.439s',\n 'text': \"else I was going to be a zombie uh let's see are we going to have The Spill the Beans emojis let's say yes we have Cheryl sending five memberships by the\"}]\n\n# Convert the response to a Python dictionary\nresponse_dict = first_response.to_dict()\nprint(response_dict)\n\n# Convert the response to JSON format\nresponse_json = first_response.to_json()\nprint(response_json)\n```\n\nHere's another simple example:\n\n```python\nfrom filmot import Categories, Countries, Language\n\n# Adjust the search query\nresponse = filmot.search(\"Spill The Beans\",\n category=Categories.GAMING,\n country=Countries.UNITED_STATES,\n language=Language.ENGLISH,\n limit=3)\n```\n\nWith this wrapper, accessing Filmot.com API becomes easy and intuitive.\nHappy coding!\n",
"bugtrack_url": null,
"license": "The MIT License Copyright (c) 2023-present Omer Duskin Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "filmot.com API",
"version": "0.0.3",
"project_urls": {
"Bug Reports": "https://github.com/dusking/filmot/issues",
"Homepage": "https://github.com/dusking/filmot",
"Source": "https://github.com/dusking/filmot.git"
},
"split_keywords": [
"filmot"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e786a00afa45d1315a0053a3bfebdd236e50eea1b9f9ea75fce26e8dd601f97b",
"md5": "421911698705bf500cf11cca15e64352",
"sha256": "8a7bc2511392ae6b2c47af657309bab2728485007ea0929165f4be139d2bfb23"
},
"downloads": -1,
"filename": "filmot-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "421911698705bf500cf11cca15e64352",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 20708,
"upload_time": "2024-02-08T19:29:19",
"upload_time_iso_8601": "2024-02-08T19:29:19.733846Z",
"url": "https://files.pythonhosted.org/packages/e7/86/a00afa45d1315a0053a3bfebdd236e50eea1b9f9ea75fce26e8dd601f97b/filmot-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "818979906740edd370c12f454b8b650380d513ddda437fdca0e76055cae5270f",
"md5": "50374ad7f5784821116f1b1179ed7c9b",
"sha256": "6d6e832a9e472a484adb45da6c2b7b12b5467196bd581add61a61fe018fbd501"
},
"downloads": -1,
"filename": "filmot-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "50374ad7f5784821116f1b1179ed7c9b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 19006,
"upload_time": "2024-02-08T19:29:21",
"upload_time_iso_8601": "2024-02-08T19:29:21.726121Z",
"url": "https://files.pythonhosted.org/packages/81/89/79906740edd370c12f454b8b650380d513ddda437fdca0e76055cae5270f/filmot-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-08 19:29:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dusking",
"github_project": "filmot",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "filmot"
}
