TikLocal 0.5.0__tar.gz

tiklocal-0.5.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 ChanMo
+
+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.

tiklocal-0.5.0/PKG-INFO

@@ -0,0 +1,103 @@
+Metadata-Version: 2.4
+Name: TikLocal
+Version: 0.5.0
+Summary: A local media server that combines the features of TikTok and Pinterest
+License: MIT
+License-File: LICENSE
+Keywords: tiklocal,tiktok,douyin,jellyfin,vlc
+Author: ChanMo
+Author-email: chan.mo@outlook.com
+Requires-Python: >=3.10,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: flask (>=3.1.0,<4.0.0)
+Requires-Dist: pyyaml (>=6.0,<7.0)
+Requires-Dist: waitress (>=3.0.2,<4.0.0)
+Project-URL: Homepage, https://github.com/ChanMo/TikLocal
+Project-URL: Repository, https://github.com/ChanMo/TikLocal
+Description-Content-Type: text/markdown
+
+# 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]
+

tiklocal-0.5.0/README.md

@@ -0,0 +1,78 @@
+# 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]

tiklocal-0.5.0/pyproject.toml

@@ -0,0 +1,28 @@
+[tool.poetry]
+name = "TikLocal"
+version = "0.5.0"
+description = "A local media server that combines the features of TikTok and Pinterest"
+authors = ["ChanMo <chan.mo@outlook.com>"]
+readme = "README.md"
+license = "MIT"
+homepage = "https://github.com/ChanMo/TikLocal"
+repository = "https://github.com/ChanMo/TikLocal"
+keywords = ["tiklocal", "tiktok", "douyin", "jellyfin", "vlc"]
+
+[tool.poetry.scripts]
+tiklocal = 'tiklocal.run:main'
+
+[tool.poetry.dependencies]
+python = ">=3.10,<4.0"
+flask = "^3.1.0"
+waitress = "^3.0.2"
+pyyaml = "^6.0"
+
+[[tool.poetry.source]]
+name = "aliyun"
+url = "https://mirrors.aliyun.com/pypi/simple"
+priority = "primary"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

tiklocal-0.5.0/tiklocal/app.py

@@ -0,0 +1,267 @@
+import os
+import json
+import random
+import datetime
+from urllib.parse import quote, unquote
+from importlib.metadata import version, PackageNotFoundError
+from pathlib import Path
+
+from flask import Flask, render_template, send_from_directory, request, redirect, send_file
+
+# Service Imports
+from tiklocal.services import LibraryService, FavoriteService, RecommendService
+from tiklocal.services.thumbnail import ThumbnailService
+
+try:
+    app_version = version("tiklocal")
+except PackageNotFoundError:
+    app_version = '1.0.0'
+
+def create_app(test_config=None):
+    app = Flask(__name__, instance_relative_config=True)
+    app.config.from_prefixed_env()
+    app.config.from_mapping(
+        SECRET_KEY = 'dev',
+        MEDIA_ROOT = Path(os.environ.get('MEDIA_ROOT', '.'))
+    )
+    app.config.from_pyfile('config.py', silent=True)
+    try:
+        os.makedirs(app.instance_path)
+    except OSError:
+        pass
+
+    # Initialize Services
+    media_root_str = str(app.config['MEDIA_ROOT'])
+    library_service = LibraryService(media_root_str)
+    favorite_service = FavoriteService(media_root_str)
+    recommend_service = RecommendService(library_service, favorite_service)
+    thumbnail_service = ThumbnailService(Path(media_root_str))
+
+    # --- Template Filters ---
+    @app.template_filter('timestamp_to_date')
+    def timestamp_to_date(timestamp):
+        try:
+            return datetime.datetime.fromtimestamp(timestamp).strftime('%Y-%m-%d %H:%M:%S')
+        except (ValueError, OSError):
+            return '未知时间'
+
+    @app.template_filter('filesizeformat')
+    def filesizeformat(num_bytes):
+        if num_bytes is None: return '0 B'
+        for unit in ['B', 'KB', 'MB', 'GB', 'TB']:
+            if num_bytes < 1024.0:
+                return f"{int(num_bytes) if unit == 'B' else f'{num_bytes:.1f}'} {unit}"
+            num_bytes /= 1024.0
+        return f"{num_bytes:.1f} PB"
+
+
+    # --- Web Routes ---
+    @app.route('/')
+    def tiktok():
+        """Immersive Video Feed"""
+        return render_template('tiktok.html', menu='index')
+
+    @app.route('/gallery')
+    def gallery():
+        """Immersive Image Discovery"""
+        return render_template('gallery.html', menu='gallery')
+
+    @app.route('/browse')
+    def browse():
+        """Video Library List"""
+        # Using scan_videos instead of recursive get_files
+        videos = library_service.scan_videos()
+        
+        # Filter Logic
+        size_mode = request.args.get('size', 'all')
+        min_mb = int(request.args.get('min_mb', 50))
+        
+        if size_mode == 'big':
+            threshold = min_mb * 1024 * 1024
+            videos = [v for v in videos if v.stat().st_size >= threshold]
+
+        # Pagination
+        count = len(videos)
+        page = int(request.args.get('page', 1))
+        length = 20
+        offset = length * (page - 1)
+        
+        # Convert to relative strings for template
+        sliced_videos = [library_service.get_relative_path(v) for v in videos[offset:offset+length]]
+        
+        return render_template(
+            'browse.html',
+            page=page,
+            count=count,
+            length=length,
+            files=sliced_videos,
+            menu='browse',
+            size_mode=size_mode,
+            min_mb=min_mb,
+            has_min_mb=request.args.get('min_mb') is not None,
+            has_previous=page > 1,
+            has_next=len(videos) > offset + length
+        )
+
+    @app.route('/settings/')
+    def settings_view():
+        video_count = len(library_service.scan_videos())
+        return render_template('settings.html', menu='settings', version=app_version, videos=video_count)
+
+    @app.route('/library')
+    def library_redirect():
+        return redirect('/browse')
+
+
+    # --- Detail & Action Routes ---
+    
+    @app.route('/detail/<path:name>')
+    def detail_view(name):
+        target = library_service.resolve_path(name)
+        if not target or not target.exists():
+            return "File not found", 404
+        
+        # Context navigation (prev/next)
+        # Note: Re-scanning every request is inefficient for large libraries, 
+        # but keeps state stateless. Optimization: Cache this.
+        videos = library_service.scan_videos()
+        video_names = [library_service.get_relative_path(v) for v in videos]
+        
+        try:
+            index = video_names.index(name)
+            prev_item = video_names[index-1] if index > 0 else None
+            next_item = video_names[index+1] if index < len(video_names)-1 else None
+        except ValueError:
+            prev_item = next_item = None
+
+        return render_template(
+            'detail.html',
+            file=name,
+            mtime=datetime.datetime.fromtimestamp(target.stat().st_mtime).strftime('%Y-%m-%d %H:%M'),
+            size=target.stat().st_size,
+            previous_item=prev_item,
+            next_item=next_item
+        )
+    
+    @app.route('/image')
+    def image_view():
+        uri = request.args.get('uri')
+        if not uri: return "Missing uri", 400
+        
+        target = library_service.resolve_path(uri)
+        if not target or not target.exists(): return "File not found", 404
+        
+        return render_template('image_detail.html', image=target, uri=uri, stat=target.stat())
+
+    @app.route("/delete/<path:name>", methods=['POST', 'GET'])
+    def delete_view(name):
+        target = library_service.resolve_path(name)
+        if request.method == 'POST':
+            if target and target.exists():
+                try:
+                    target.unlink()
+                    # Thumbnails are handled by OS or periodic cleanup, but ideally Service should handle it
+                except Exception as e:
+                    return f"Error deleting file: {e}", 500
+            return redirect('/browse')
+
+        return render_template('delete_confirm.html', file=name)
+        
+    @app.route("/delete", methods=['POST', 'GET'])
+    def delete_confirm_legacy():
+        # Legacy support for query param style
+        uri = request.args.get('uri')
+        if not uri: return redirect('/browse')
+        return redirect(f"/delete/{quote(uri)}")
+
+    @app.route('/favorite')
+    def favorite_view():
+        return render_template('favorite.html', files=list(favorite_service.load()))
+
+
+    # --- Media Serving Routes ---
+
+    @app.route("/media/<path:filename>")
+    def serve_media(filename):
+        # Consolidated media serving
+        try:
+            return send_from_directory(app.config["MEDIA_ROOT"], filename)
+        except Exception:
+            return "File not found", 404
+
+    @app.route("/media")
+    def serve_media_legacy():
+        # Legacy support for /media?uri=...
+        uri = request.args.get('uri')
+        if not uri: return "Missing uri", 400
+        return redirect(f"/media/{uri}")
+
+    @app.route('/thumb')
+    def thumb_view():
+        uri = request.args.get('uri')
+        if not uri: return send_file(io.BytesIO(thumbnail_service.placeholder), mimetype='image/png')
+        
+        path, mimetype = thumbnail_service.get_thumbnail(unquote(uri))
+        if isinstance(path, bytes):
+            return send_file(io.BytesIO(path), mimetype=mimetype)
+        return send_file(path, mimetype=mimetype)
+
+
+    # --- API Routes ---
+
+    @app.route('/api/videos')
+    def api_videos():
+        # Clean JSON API
+        selected = recommend_service.get_weighted_selection(file_type='video', limit=20)
+        return json.dumps(selected)
+
+    @app.route('/api/random-images')
+    def api_random_images():
+        page = int(request.args.get('page', 1))
+        size = int(request.args.get('size', 30))
+        seed = request.args.get('seed') or str(random.randint(1, 999999))
+        
+        # Get recommended images (all of them, weighted)
+        # Note: RecommendService currently returns a list. For true scale, we'd paginate inside Service.
+        # For now, consistent with previous behavior, we get all and slice.
+        all_images = recommend_service.get_weighted_selection(file_type='image', limit=99999, seed=seed)
+        
+        total = len(all_images)
+        start = (page - 1) * size
+        end = start + size
+        page_images = all_images[start:end]
+        
+        return {
+            'images': page_images,
+            'page': page,
+            'total': total,
+            'has_more': end < total,
+            'seed': seed
+        }
+
+    @app.route('/api/favorite/<path:name>', methods=['GET', 'POST'])
+    def api_favorite(name):
+        if request.method == 'GET':
+            return {'favorite': favorite_service.is_favorite(name)}
+        
+        new_state = favorite_service.toggle(name)
+        return {'success': True, 'favorite': new_state}
+
+    @app.route('/api/thumbnail/<path:name>', methods=['POST'])
+    def api_set_thumbnail(name):
+        target = library_service.resolve_path(name)
+        if not target: return {'success': False, 'error': 'Invalid path'}, 400
+        
+        payload = request.get_json(silent=True) or {}
+        ts = payload.get('time')
+        
+        # This logic is a bit specific to app.py still, ideally move to ThumbnailService
+        # But for now, we just need to regen the thumb
+        thumb_path = thumbnail_service._get_thumb_path(name)
+        success = thumbnail_service._generate(target, thumb_path, timestamp=float(ts) if ts else None)
+        
+        if success:
+             return {'success': True, 'url': f"/thumb?uri={quote(name)}&v={int(datetime.datetime.now().timestamp())}"}
+        return {'success': False, 'error': 'Failed to generate'}, 500
+
+    return app

tiklocal-0.5.0/tiklocal/paths.py

@@ -0,0 +1,26 @@
+import os
+from pathlib import Path
+
+
+def get_data_dir() -> Path:
+    """Return the global data directory for TikLocal.
+    Default to ~/.tiklocal unless TIKLOCAL_INSTANCE is set.
+    """
+    base = os.environ.get('TIKLOCAL_INSTANCE')
+    if base:
+        p = Path(base).expanduser()
+    else:
+        p = Path.home() / '.tiklocal'
+    p.mkdir(parents=True, exist_ok=True)
+    return p
+
+
+def get_thumbnails_dir() -> Path:
+    d = get_data_dir() / 'thumbnails'
+    d.mkdir(parents=True, exist_ok=True)
+    return d
+
+
+def get_thumbs_map_path() -> Path:
+    return get_data_dir() / 'thumbs.json'
+

tiklocal-0.5.0/tiklocal/run.py

@@ -0,0 +1,139 @@
+import os
+import sys
+import argparse
+from pathlib import Path
+from waitress import serve
+from tiklocal.app import create_app
+from tiklocal.thumbs import generate_thumbnails
+from tiklocal.paths import get_data_dir
+
+try:
+    import yaml
+except ImportError:
+    yaml = None
+
+
+def load_config():
+    """从配置文件加载配置"""
+    config = {}
+
+    # 尝试读取配置文件
+    config_paths = [
+        Path.home() / '.config' / 'tiklocal' / 'config.yaml',
+        Path.home() / '.tiklocal' / 'config.yaml',
+    ]
+
+    for config_path in config_paths:
+        if config_path.exists():
+            if yaml is None:
+                print(f"警告: 找到配置文件 {config_path} 但未安装 PyYAML，跳过配置文件", file=sys.stderr)
+                break
+            try:
+                with open(config_path, 'r', encoding='utf-8') as f:
+                    config = yaml.safe_load(f) or {}
+                break
+            except Exception as e:
+                print(f"警告: 读取配置文件 {config_path} 失败: {e}", file=sys.stderr)
+
+    return config
+
+
+def main():
+    # 读取配置文件
+    config = load_config()
+
+    # 预处理 argv，支持以下形式：
+    # 1) tiklocal                      -> serve
+    # 2) tiklocal /path                -> serve /path
+    # 3) tiklocal --port 9000          -> serve --port 9000
+    # 4) tiklocal thumbs /path         -> thumbs /path
+    # 5) tiklocal /path thumbs         -> thumbs /path
+    argv = sys.argv[1:]
+    if '-h' not in argv and '--help' not in argv:
+        if 'thumbs' in argv:
+            idx = argv.index('thumbs')
+            if idx != 0:
+                argv.pop(idx)
+                argv.insert(0, 'thumbs')
+        elif len(argv) == 0 or argv[0] not in ('serve', 'thumbs'):
+            # 默认回退 serve（空参数或第一个不是已知子命令）
+            argv.insert(0, 'serve')
+
+    # 解析命令行参数（支持子命令）
+    parser = argparse.ArgumentParser(
+        description='TikLocal - 本地媒体服务器',
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+        epilog='''
+示例:
+  tiklocal                                 # 启动服务（默认）
+  tiklocal /path/to/media                  # 指定媒体目录
+  tiklocal --port 9000                     # 使用指定端口
+  tiklocal serve /path --port 9000         # 显式使用 serve 子命令
+  tiklocal thumbs /path --overwrite        # 批量生成缩略图
+        '''
+    )
+
+    subparsers = parser.add_subparsers(dest='command')
+
+    # serve 子命令
+    serve_parser = subparsers.add_parser('serve', help='启动服务器')
+    serve_parser.add_argument('media_root', nargs='?', help='媒体文件根目录路径')
+    serve_parser.add_argument('--host', default=None, help='服务器监听地址 (默认: 0.0.0.0)')
+    serve_parser.add_argument('--port', type=int, default=None, help='服务器端口 (默认: 8000)')
+
+    # thumbs 子命令
+    thumbs_parser = subparsers.add_parser('thumbs', help='批量生成视频缩略图')
+    thumbs_parser.add_argument('media_root', nargs='?', help='媒体文件根目录路径（可省略以使用环境变量/配置文件）')
+    thumbs_parser.add_argument('--overwrite', action='store_true', help='存在时覆盖重建')
+    thumbs_parser.add_argument('--limit', type=int, default=0, help='最多处理多少个（0 表示全部）')
+
+    args = parser.parse_args(argv)
+
+    # 判断命令类型（无子命令时视为 serve）
+    cmd = args.command or 'serve'
+
+    if cmd == 'thumbs':
+        media_root = args.media_root or os.environ.get('MEDIA_ROOT') or config.get('media_root')
+        if not media_root:
+            parser.error('必须指定媒体目录:\n  - tiklocal thumbs /path/to/media\n  - 或设置环境变量: MEDIA_ROOT=/path/to/media')
+        media_path = Path(media_root)
+        if not media_path.exists() or not media_path.is_dir():
+            print(f"错误: 媒体目录不可用: {media_root}", file=sys.stderr)
+            sys.exit(1)
+        print(f"数据目录: {get_data_dir()}")
+        stats = generate_thumbnails(media_path, overwrite=getattr(args, 'overwrite', False), limit=getattr(args, 'limit', 0), show_progress=True)
+        # 完成后退出
+        return
+
+    # serve 路径
+    media_root = args.media_root or os.environ.get('MEDIA_ROOT') or config.get('media_root')
+    host = args.host or os.environ.get('TIKLOCAL_HOST') or config.get('host', '0.0.0.0')
+    port = args.port or int(os.environ.get('TIKLOCAL_PORT', 0)) or config.get('port', 8000)
+
+    # 验证媒体目录
+    if not media_root:
+        parser.error('必须指定媒体目录:\n  - 通过命令行参数: tiklocal /path/to/media\n  - 通过环境变量: MEDIA_ROOT=/path/to/media\n  - 通过配置文件: ~/.config/tiklocal/config.yaml')
+
+    media_path = Path(media_root)
+    if not media_path.exists():
+        print(f"错误: 媒体目录不存在: {media_root}", file=sys.stderr)
+        sys.exit(1)
+
+    if not media_path.is_dir():
+        print(f"错误: 路径不是目录: {media_root}", file=sys.stderr)
+        sys.exit(1)
+
+    # 设置环境变量供 Flask 使用
+    os.environ['MEDIA_ROOT'] = str(media_path.absolute())
+
+    # 启动服务器
+    print(f"启动 TikLocal 服务器...")
+    print(f"媒体目录: {media_path.absolute()}")
+    print(f"数据目录: {get_data_dir()}")
+    print(f"访问地址: http://{host}:{port}")
+
+    serve(create_app(), host=host, port=port)
+
+
+if __name__ == '__main__':
+    main()