<h1 align="center">TikTokPy</h1>
<div align="center">
<a href="https://pypi.org/project/tiktokapipy/">
<img src="https://img.shields.io/pypi/v/tiktokapipy?style=flat-square&logo=pypi" alt="PyPI">
</a>
<a href="https://www.python.org">
<img src="https://img.shields.io/badge/python-3.8+-blue.svg?style=flat-square&logo=python" alt="Python Version 3.8+">
</a>
<a href="https://pypi.org/project/tiktokapipy/">
<img alt="License" src="https://img.shields.io/github/license/Russell-Newton/TikTokPy?style=flat-square">
</a>
<br>
<a href="https://github.com/Russell-Newton/TikTokPy/actions/workflows/tox.yml">
<img src="https://img.shields.io/github/actions/workflow/status/Russell-Newton/TikTokPy/tox.yml?branch=main&label=Unit%20Tests&logo=github&style=flat-square" alt="Unit Tests Status">
</a>
<a href='https://tiktokpy.readthedocs.io/en/stable/'>
<img src='https://readthedocs.org/projects/tiktokpy/badge/?version=stable&style=flat-square' alt='Documentation Status' />
</a>
</div>
**Extract data from TikTok without needing any login information or API keys.**
## Table of Contents
* [Getting Started](#getting-started)
* [Installation](#installation)
* [Quick Start Guide](#quick-start-guide)
* [Documentation](#documentation)
* [Disclaimer](#disclaimer)
## Getting Started
### Installation
Install the ``tiktokapipy`` package (or add it to your project requirements) and set up Playwright:
```shell
pip install tiktokapipy
python -m playwright install
```
### Quick Start Guide
TikTokPy has both a synchronous and an asynchronous API. The interfaces are the same, but the asynchronous API
requires awaiting of certain functions and iterators.
Both APIs must be used as context managers. To get video information in both APIs:
<table>
<tr>
<th>Synchronous</th>
<th>Asynchronous</th>
</tr>
<tr>
<td>
```py
from tiktokapipy.api import TikTokAPI
with TikTokAPI() as api:
video = api.video(video_link)
...
```
</td>
<td>
```py
from tiktokapipy.async_api import AsyncTikTokAPI
async with AsyncTikTokAPI() as api:
video = await api.video(video_link)
...
```
</td>
</tr>
</table>
More examples, including how to download videos and slideshows, can be found in the
[documentation](https://tiktokpy.readthedocs.io/en/latest/users/usage.html#examples).
Warnings can be ignored as follows:
```py
import warnings
from tiktokapipy import TikTokAPIWarning
warnings.filterwarnings("ignore", category=TikTokAPIWarning)
```
## Documentation
You can view the full documentation on [Read the Docs](https://tiktokpy.readthedocs.io/en/latest/).
<hr>
## Disclaimer
TikTokPy is in no way affiliated with, authorized, maintained, sponsored or endorsed by TikTok or any of its affiliates or subsidiaries. Use of automated scripts to collect information from or otherwise interact with TikTok and its related services is against [TikTok's Terms of Service](https://www.tiktok.com/legal/page/us/terms-of-service/en). Use at your own risk. For educational purposes only.
Raw data
{
"_id": null,
"home_page": "",
"name": "tiktokapipy",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "tiktok,python3,scraper,unofficial,tiktok-scraper,tiktok scraper,asyncio,playwright-python",
"author": "",
"author_email": "Russell Newton <russell.newton01@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/c6/02/3a1bd5704f8376752b6ef2095c2e24577ba88aec7e6663e8a7a843f5a42b/tiktokapipy-0.2.4.post2.tar.gz",
"platform": null,
"description": "<h1 align=\"center\">TikTokPy</h1>\n<div align=\"center\">\n <a href=\"https://pypi.org/project/tiktokapipy/\">\n <img src=\"https://img.shields.io/pypi/v/tiktokapipy?style=flat-square&logo=pypi\" alt=\"PyPI\">\n </a>\n <a href=\"https://www.python.org\">\n <img src=\"https://img.shields.io/badge/python-3.8+-blue.svg?style=flat-square&logo=python\" alt=\"Python Version 3.8+\">\n </a>\n <a href=\"https://pypi.org/project/tiktokapipy/\">\n <img alt=\"License\" src=\"https://img.shields.io/github/license/Russell-Newton/TikTokPy?style=flat-square\">\n </a>\n <br>\n <a href=\"https://github.com/Russell-Newton/TikTokPy/actions/workflows/tox.yml\">\n <img src=\"https://img.shields.io/github/actions/workflow/status/Russell-Newton/TikTokPy/tox.yml?branch=main&label=Unit%20Tests&logo=github&style=flat-square\" alt=\"Unit Tests Status\">\n </a>\n <a href='https://tiktokpy.readthedocs.io/en/stable/'>\n <img src='https://readthedocs.org/projects/tiktokpy/badge/?version=stable&style=flat-square' alt='Documentation Status' />\n </a>\n</div>\n\n**Extract data from TikTok without needing any login information or API keys.**\n\n## Table of Contents\n\n* [Getting Started](#getting-started)\n * [Installation](#installation)\n * [Quick Start Guide](#quick-start-guide)\n* [Documentation](#documentation)\n* [Disclaimer](#disclaimer)\n\n## Getting Started\n\n### Installation\n\nInstall the ``tiktokapipy`` package (or add it to your project requirements) and set up Playwright:\n\n```shell\npip install tiktokapipy\npython -m playwright install\n```\n\n### Quick Start Guide\n\nTikTokPy has both a synchronous and an asynchronous API. The interfaces are the same, but the asynchronous API\nrequires awaiting of certain functions and iterators.\n\nBoth APIs must be used as context managers. To get video information in both APIs:\n\n<table>\n<tr>\n<th>Synchronous</th>\n<th>Asynchronous</th>\n</tr>\n<tr>\n<td>\n\n```py\nfrom tiktokapipy.api import TikTokAPI\n\nwith TikTokAPI() as api:\n video = api.video(video_link)\n ...\n```\n\n</td>\n<td>\n\n```py\nfrom tiktokapipy.async_api import AsyncTikTokAPI\n\nasync with AsyncTikTokAPI() as api:\n video = await api.video(video_link)\n ...\n```\n\n</td>\n</tr>\n</table>\n\nMore examples, including how to download videos and slideshows, can be found in the\n[documentation](https://tiktokpy.readthedocs.io/en/latest/users/usage.html#examples).\n\nWarnings can be ignored as follows:\n\n```py\nimport warnings\n\nfrom tiktokapipy import TikTokAPIWarning\n\nwarnings.filterwarnings(\"ignore\", category=TikTokAPIWarning)\n```\n\n## Documentation\n\nYou can view the full documentation on [Read the Docs](https://tiktokpy.readthedocs.io/en/latest/).\n\n<hr>\n\n## Disclaimer\n\nTikTokPy is in no way affiliated with, authorized, maintained, sponsored or endorsed by TikTok or any of its affiliates or subsidiaries. Use of automated scripts to collect information from or otherwise interact with TikTok and its related services is against [TikTok's Terms of Service](https://www.tiktok.com/legal/page/us/terms-of-service/en). Use at your own risk. For educational purposes only.\n",
"bugtrack_url": null,
"license": "",
"summary": "Asyncio TikTok data scraping tool",
"version": "0.2.4.post2",
"project_urls": {
"Documentation": "https://tiktokpy.readthedocs.io/en/latest/",
"Homepage": "https://github.com/Russell-Newton/TikTokPy"
},
"split_keywords": [
"tiktok",
"python3",
"scraper",
"unofficial",
"tiktok-scraper",
"tiktok scraper",
"asyncio",
"playwright-python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "263212a8b00eeacfc236fcac2a8a18dca227112aa14e6df81be06f2acbe3d61c",
"md5": "7e52ab250edab3966695549e21761b0f",
"sha256": "4b5b06945e9b2a5d2f4295bed014cce9b463c32de36829e68fbfb640bac51a64"
},
"downloads": -1,
"filename": "tiktokapipy-0.2.4.post2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7e52ab250edab3966695549e21761b0f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 34497,
"upload_time": "2023-11-20T19:31:00",
"upload_time_iso_8601": "2023-11-20T19:31:00.748288Z",
"url": "https://files.pythonhosted.org/packages/26/32/12a8b00eeacfc236fcac2a8a18dca227112aa14e6df81be06f2acbe3d61c/tiktokapipy-0.2.4.post2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c6023a1bd5704f8376752b6ef2095c2e24577ba88aec7e6663e8a7a843f5a42b",
"md5": "5af3f910fde6c31f0fb20739aac0855f",
"sha256": "1114ef422e3b0dab94010151f721c2e00ffea15b8f97be905c55d639449ccce1"
},
"downloads": -1,
"filename": "tiktokapipy-0.2.4.post2.tar.gz",
"has_sig": false,
"md5_digest": "5af3f910fde6c31f0fb20739aac0855f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 31213,
"upload_time": "2023-11-20T19:31:02",
"upload_time_iso_8601": "2023-11-20T19:31:02.592000Z",
"url": "https://files.pythonhosted.org/packages/c6/02/3a1bd5704f8376752b6ef2095c2e24577ba88aec7e6663e8a7a843f5a42b/tiktokapipy-0.2.4.post2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-20 19:31:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Russell-Newton",
"github_project": "TikTokPy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "tiktokapipy"
}
JSON
