flinck 项目使用教程

flinck 项目使用教程

flinck Sort your movies on filesystem by dates, ratings, etc using symlinks. 项目地址: https://gitcode.com/gh_mirrors/fl/flinck

1. 项目的目录结构及介绍

flinck/
├── docs/
│   └── ...
├── flinck/
│   ├── __init__.py
│   ├── flinck.py
│   └── ...
├── tests/
│   └── ...
├── .travis.yml
├── LICENSE
├── MANIFEST.in
├── README.md
├── requirements.txt
├── setup.py
└── tox.ini

• docs/: 存放项目的文档文件。
• flinck/: 项目的主要代码目录，包含核心功能实现。
  • init.py: Python包的初始化文件。
  • flinck.py: 项目的主程序文件，包含主要的逻辑和功能。
• tests/: 存放项目的测试代码。
• .travis.yml: Travis CI 的配置文件，用于持续集成。
• LICENSE: 项目的开源许可证文件。
• MANIFEST.in: 用于指定在打包时需要包含的文件。
• README.md: 项目的介绍和使用说明。
• requirements.txt: 项目依赖的Python包列表。
• setup.py: 项目的安装配置文件。
• tox.ini: 用于配置 tox 测试工具。

2. 项目的启动文件介绍

项目的启动文件是 flinck/flinck.py。该文件包含了项目的核心逻辑和功能实现。通过命令行调用该文件，可以启动项目的各项功能。

# flinck/flinck.py

import sys
import click

@click.command()
@click.argument('file_or_dir', type=click.Path(exists=True))
@click.option('-l', '--link_dir', type=click.Path(), help='Links root directory')
@click.option('-b', '--by', type=click.Choice(['country', 'decade', 'director', 'genre', 'rating', 'runtime', 'title', 'year']), multiple=True, help='Organize medias by')
@click.option('-v', '--verbose', is_flag=True, help='Verbose mode')
@click.version_option()
def main(file_or_dir, link_dir, by, verbose):
    """Organize your movie collection using symbolic links."""
    # 主逻辑代码
    pass

if __name__ == '__main__':
    main()

3. 项目的配置文件介绍

项目的配置文件通常是一个 YAML 文件，用于配置项目的各项参数。配置文件的示例如下：

link_root_dir: '/Volumes/Disque dur/Movies'
genre:
  dirs: true
  buckets: true
rating:
  link_format: '%rating-%year-%title'
  dirs: false
  buckets: true
decade:
  dirs: true

• link_root_dir: 指定链接的根目录。
• genre: 配置按类型分类的选项。
  • dirs: 是否按目录分类。
  • buckets: 是否按字母分桶。
• rating: 配置按评分分类的选项。
  • link_format: 链接的命名格式。
  • dirs: 是否按目录分类。
  • buckets: 是否按字母分桶。
• decade: 配置按年代分类的选项。
  • dirs: 是否按目录分类。

flinck Sort your movies on filesystem by dates, ratings, etc using symlinks. 项目地址: https://gitcode.com/gh_mirrors/fl/flinck