| Name | TikLocal JSON |
| Version |
0.4.0
JSON |
| download |
| home_page | None |
| Summary | A local media server that combines the features of TikTok and Pinterest |
| upload_time | 2025-10-11 16:06:10 |
| maintainer | None |
| docs_url | None |
| author | ChanMo |
| requires_python | <4.0,>=3.10 |
| license | MIT |
| keywords |
tiklocal
tiktok
douyin
jellyfin
vlc
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# TikLocal
**TikLocal** is a **mobile and tablet** **web application** built on **Flask**. It allows you to browse and manage your local videos and images in a way similar to TikTok and Pinterest.
[中文](./README_zh.md)
## Introduction
TikLocal's main features include:
* **A TikTok-like swipe-up browsing experience** that allows you to easily and quickly browse local video files.
* **A file manager-like directory browsing** feature that allows you to easily find and manage local video files.
* **A Pinterest-like grid layout** feature that allows you to enjoy local images.
* **Support for light and dark modes** to suit your personal preferences.
## Use cases
TikLocal is suitable for the following use cases:
* You don't trust TikTok's teen mode and want to provide your child with completely controllable video content.
* You want to browse and manage your local videos and images locally, but don't want to use third-party cloud services.
* You want to use a TikTok-style video browsing experience on your phone or tablet.
* You want to use a Pinterest-style image browsing experience on your phone or tablet.
## How to use
### Installation
TikLocal is a Python application that you can install using the following command:
```
pip install tiklocal
```
### Usage
Starting TikLocal is very simple, just run the following command:
```
tiklocal ~/Videos/
```
You can specify any media folder.
To close, press `Ctrl + C`.
### Configuration
TikLocal provides some configuration options that you can adjust to your needs.
* **Light and dark modes:** You can choose to use light or dark mode.
* **Video playback speed:** You can adjust the video playback speed.
## TODO
* [ ] Add search
* [ ] Add more management operations, such as moving files and creating folders
* [ ] Add basic login control
* [ ] Add a bookmarking feature
* [ ] Add a Docker image
* [ ] Add a tagging feature
* [ ] Use recommendation algorithms
## Contribution
TikLocal is an open source project that you can contribute to in the following ways:
* Submit code or documentation improvements.
* Report bugs.
* Suggest new features.
## Contact us
If you have any questions or suggestions, you can contact us in the following ways:
* GitHub project page: [https://github.com/ChanMo/TikLocal/](https://github.com/ChanMo/TikLocal/)
* Email: [chan.mo@outlook.com]
Raw data
{
"_id": null,
"home_page": null,
"name": "TikLocal",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "tiklocal, tiktok, douyin, jellyfin, vlc",
"author": "ChanMo",
"author_email": "chan.mo@outlook.com",
"download_url": "https://files.pythonhosted.org/packages/87/5d/d3e2d129100794788fefc1304a5fd7ba3814e19c3f066d20b89a00346178/tiklocal-0.4.0.tar.gz",
"platform": null,
"description": "# TikLocal\n\n**TikLocal** is a **mobile and tablet** **web application** built on **Flask**. It allows you to browse and manage your local videos and images in a way similar to TikTok and Pinterest.\n\n[\u4e2d\u6587](./README_zh.md)\n\n## Introduction\n\nTikLocal's main features include:\n\n* **A TikTok-like swipe-up browsing experience** that allows you to easily and quickly browse local video files.\n* **A file manager-like directory browsing** feature that allows you to easily find and manage local video files.\n* **A Pinterest-like grid layout** feature that allows you to enjoy local images.\n* **Support for light and dark modes** to suit your personal preferences.\n\n## Use cases\n\nTikLocal is suitable for the following use cases:\n\n* You don't trust TikTok's teen mode and want to provide your child with completely controllable video content.\n* You want to browse and manage your local videos and images locally, but don't want to use third-party cloud services.\n* You want to use a TikTok-style video browsing experience on your phone or tablet.\n* You want to use a Pinterest-style image browsing experience on your phone or tablet.\n\n## How to use\n\n### Installation\n\nTikLocal is a Python application that you can install using the following command:\n\n```\npip install tiklocal\n```\n\n### Usage\n\nStarting TikLocal is very simple, just run the following command:\n\n```\ntiklocal ~/Videos/\n```\n\nYou can specify any media folder.\n\nTo close, press `Ctrl + C`.\n\n### Configuration\n\nTikLocal provides some configuration options that you can adjust to your needs.\n\n* **Light and dark modes:** You can choose to use light or dark mode.\n* **Video playback speed:** You can adjust the video playback speed.\n\n\n## TODO\n\n* [ ] Add search\n* [ ] Add more management operations, such as moving files and creating folders\n* [ ] Add basic login control\n* [ ] Add a bookmarking feature\n* [ ] Add a Docker image\n* [ ] Add a tagging feature\n* [ ] Use recommendation algorithms\n\n## Contribution\n\nTikLocal is an open source project that you can contribute to in the following ways:\n\n* Submit code or documentation improvements.\n* Report bugs.\n* Suggest new features.\n\n## Contact us\n\nIf you have any questions or suggestions, you can contact us in the following ways:\n\n* GitHub project page: [https://github.com/ChanMo/TikLocal/](https://github.com/ChanMo/TikLocal/)\n* Email: [chan.mo@outlook.com]\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A local media server that combines the features of TikTok and Pinterest",
"version": "0.4.0",
"project_urls": {
"Homepage": "https://github.com/ChanMo/TikLocal",
"Repository": "https://github.com/ChanMo/TikLocal"
},
"split_keywords": [
"tiklocal",
" tiktok",
" douyin",
" jellyfin",
" vlc"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "3bbc5ce385ca4c23607aece4cea67b9b9d3b8c9462e78d956792dee839ec72c9",
"md5": "b13f439e0e5d377c9278b225eea26e0f",
"sha256": "b435c19d50197c2b404378ba12738988219d8806b168df6b78330fea510c6061"
},
"downloads": -1,
"filename": "tiklocal-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b13f439e0e5d377c9278b225eea26e0f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 69681,
"upload_time": "2025-10-11T16:06:08",
"upload_time_iso_8601": "2025-10-11T16:06:08.963812Z",
"url": "https://files.pythonhosted.org/packages/3b/bc/5ce385ca4c23607aece4cea67b9b9d3b8c9462e78d956792dee839ec72c9/tiklocal-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "875dd3e2d129100794788fefc1304a5fd7ba3814e19c3f066d20b89a00346178",
"md5": "ad0ac5ad09dd41a2418e4b2e6e8363cb",
"sha256": "1ec02d017332300593e9d2dfd2272d7d224c487ecb409db00c92fba3f0f911c9"
},
"downloads": -1,
"filename": "tiklocal-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "ad0ac5ad09dd41a2418e4b2e6e8363cb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 60738,
"upload_time": "2025-10-11T16:06:10",
"upload_time_iso_8601": "2025-10-11T16:06:10.386944Z",
"url": "https://files.pythonhosted.org/packages/87/5d/d3e2d129100794788fefc1304a5fd7ba3814e19c3f066d20b89a00346178/tiklocal-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-11 16:06:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ChanMo",
"github_project": "TikLocal",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "tiklocal"
}
