Metadata-Version: 2.1
Name: music-tool-kit
Version: 1.2.9
Summary: A tool kit for music download and clip
Home-page: https://github.com/nichuanfang/music-tool-kit
Author: Nichuan Fang
Author-email: f18326186224@gmail.com
License: MIT
Project-URL: Source Code, https://github.com/nichuanfang/music-tool-kit
Project-URL: Bug Tracker, https://github.com/nichuanfang/music-tool-kit/issues
Project-URL: Documentation, https://github.com/nichuanfang/music-tool-kit#music-tool-kit-%E9%9F%B3%E4%B9%90%E5%B7%A5%E5%85%B7%E7%AE%B1
Keywords: mkmtkmusic,musictool,musicdownload,musicclip,musickit,musictoolkit
Platform: any
Classifier: Development Status :: 1 - Planning
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: Chinese (Simplified)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Multimedia :: Sound/Audio
Classifier: Topic :: Utilities
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE

**music-tool-kit**，主要使用场景为提取[youtube](https://www.youtube.com)和[bilibili](https://www.bilibili.com)视频中的音频,支持**音频下载**,**元信息自动补全**,**音频截取**,**提取伴奏**,**youtube 列表批量下载**,**自定义批量下载**等.配合[spotify](https://open.spotify.com)的**本地文件**功能可以极大的提升音乐体验([教程](https://www.bilibili.com/video/BV1VL411T7mp/?vd_source=04c6a0d121b6fb871e3d3c0a2554b29b))

> [!NOTE]
>
> 本项目仅为个人使用,无任何商业用途,仅支持 mp3 格式的音乐

---
**内容目录**：
- [环境准备](#环境准备)
  - [安装](#安装)
  - [升级](#升级)
  - [卸载](#卸载)
- [使用](#使用)
  - [音乐下载](#音乐下载)
  - [音乐搜索](#音乐搜索)
  - [音乐剪辑](#音乐剪辑)
  - [提取伴奏](#提取伴奏)
  - [csv 批量模板](#csv-批量模板)
  - [批量下载](#批量下载)
- [License](#license)

# 环境准备

## 安装

```bash
python -m pip install –upgrade pip
pip install -U music-tool-kit
```

![help](https://raw.githubusercontent.com/nichuanfang/music-tool-kit/main/example/help.png)

> [!IMPORTANT]
>
> - [python](https://www.python.org/)版本:**3.11.0及以上**
> - 需安装[ffmpeg](https://ffmpeg.org/)并正确配置环境变量
> - 如果需要下载youtube的音乐,需要准备**科学上网**环境
> - `[]`标记的项目表示可不填
> - 为规避特殊字符导致路径识别失败,**标题**、**路径**、**URL**等相关的参数尽量使用**双引号**`""`

## 升级

```bash
pip install -U music-tool-kit
```

## 卸载

```bash
pip uninstall music-tool-kit
```

# 使用

## 音乐下载

```bash
mk  "网址" "[标题]" "[封面url]"

```

**普通下载**
![download](https://raw.githubusercontent.com/nichuanfang/music-tool-kit/main/example/download.png)

**列表下载**使用方法为 `mk "列表url | 列表序号"` ,**url 需要为 [youtube](https://www.youtube.com) 的列表格式(url中含有list=)**,如果想下载全部歌曲,直接输入 `mk "列表url |"` 即可!

例如:
```bash
mk "https://www.youtube.com/playlist?list=PL8B3F8A7B0A9F4DE8 | 1,2,3,4,5"
```
![download_list](https://raw.githubusercontent.com/nichuanfang/music-tool-kit/main/example/batch_download.png)

> [!TIP]
>
> - 标题格式为 **歌曲名-歌手(专辑名)** 输出歌曲格式默认为 **mp3**
> - music-tool-kit会根据**标题**,自动将下载的音频元信息补全,包括歌曲名,歌手(艺术家),内置封面图片,以及专辑名称.如果不遵循该标题格式,元信息可能补全失败
> - 仅支持下载 youtube 的列表下载,url|后面的列表序号之间需要用逗号分隔

## 音乐搜索

```bash
mk -s "关键字"
```
![search](https://raw.githubusercontent.com/nichuanfang/music-tool-kit/main/example/search.png)
支持 youtube bilibili 输出优先级 youtube > bilibili,输入列表序号,输入标题,完成下载

> [!TIP]
>
> - 最多显示20条数据
> - 直接按`Enter`可以跳出序号选择界面,输入的序号不能超过最大返回的条目数
> - 如果不想设置标题 直接按`Enter`即可

## 音乐剪辑

```bash
mk -c "输入的mp3文件" 开始时间 结束时间
```

![clip](https://raw.githubusercontent.com/nichuanfang/music-tool-kit/main/example/clip.png)

> Tips: 时间格式为 `00:00:00`

## 提取伴奏

```bash
mk -e "输入的mp3文件" [模型名称]
```

支持的模型:

- `UVR_MDXNET_Main` (整体较好)
- `UVR-MDX-NET-Inst_Main` (整体较好)
- `UVR-MDX-NET-Inst_3` (整体较好)
- `UVR-MDX-NET-Inst_HQ_3` (整体较好)
- `UVR_MDXNET_KARA_2` (一般,人声剔除不干净,声音忽高忽低)
- `Kim_Inst` (一般)

![extract](https://raw.githubusercontent.com/nichuanfang/music-tool-kit/main/example/inst.png)

> [!WARNING]
> - 默认模型为`UVR_MDXNET_Main`,具体请结合音乐类型和自己的实际听感自行调整模型
> - 伴奏提取比较吃 cpu 性能,时间比较漫长,请耐心等待,大概需要 5~10 分钟

## csv 批量模板

```bash
mk -t
```

生成的模板文件如下:
![csv_template](https://raw.githubusercontent.com/nichuanfang/music-tool-kit/main/example/csv_template.png)
用户自行填写下载信息,保存后使用`mk "csv文件"`即可批量下载

| url  | title | cover_url | start_time | end_time | instrumental |
| ---- | ----- | --------- | ---------- | -------- | ------------ |
| 网址 | 标题  | 封面 url  | 开始时间   | 结束时间 | 是否生成伴奏(true or false) |

## 批量下载

```bash
mk "csv文件"
```

![csv_download](https://raw.githubusercontent.com/nichuanfang/music-tool-kit/main/example/csv_download.png)

# License

This work is released under the MIT license. A copy of the license is provided in the [LICENSE](https://raw.githubusercontent.com/nichuanfang/music-tool-kit/main/LICENSE) file.
