mvsep-cli 1.0.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,160 @@
1
+ Metadata-Version: 2.4
2
+ Name: mvsep-cli
3
+ Version: 1.0.0
4
+ Summary: Command-line interface for MVSEP music separation API
5
+ Author-email: MVSEP <contact@mvsep.com>
6
+ License: MIT
7
+ Project-URL: Homepage, https://github.com/mvsep/mvsep-cli
8
+ Project-URL: Repository, https://github.com/mvsep/mvsep-cli
9
+ Project-URL: Documentation, https://github.com/mvsep/mvsep-cli#readme
10
+ Keywords: mvsep,music,separation,audio,vocals,demucs,audio-processing
11
+ Classifier: Development Status :: 4 - Beta
12
+ Classifier: Environment :: Console
13
+ Classifier: Intended Audience :: End Users/Desktop
14
+ Classifier: License :: OSI Approved :: MIT License
15
+ Classifier: Programming Language :: Python :: 3
16
+ Classifier: Programming Language :: Python :: 3.8
17
+ Classifier: Programming Language :: Python :: 3.9
18
+ Classifier: Programming Language :: Python :: 3.10
19
+ Classifier: Programming Language :: Python :: 3.11
20
+ Classifier: Programming Language :: Python :: 3.12
21
+ Requires-Python: >=3.8
22
+ Description-Content-Type: text/markdown
23
+ Requires-Dist: requests>=2.28.0
24
+
25
+ # MVSEP CLI
26
+
27
+ A command-line interface for [MVSEP](https://mvsep.com) music separation API.
28
+
29
+ ## Features
30
+
31
+ - Upload audio files and create separation tasks
32
+ - Monitor task status in real-time
33
+ - Download separated tracks automatically
34
+ - Support for multiple separation algorithms and models
35
+ - Configurable default settings
36
+ - Support for mirror sites (China)
37
+
38
+ ## Installation
39
+
40
+ ```bash
41
+ pip install mvsep-cli
42
+ ```
43
+
44
+ Or install from source:
45
+
46
+ ```bash
47
+ pip install -e .
48
+ ```
49
+
50
+ ## Mirror Sites
51
+
52
+ MVSEP provides mirror sites for better access in different regions:
53
+
54
+ | Mirror | URL |
55
+ |--------|-----|
56
+ | main | https://mvsep.com |
57
+ | mirror | https://mirror.mvsep.com (China) |
58
+
59
+ Set your preferred mirror:
60
+
61
+ ```bash
62
+ mvsep config set-mirror mirror # Use China mirror
63
+ mvsep config set-mirror main # Use main site
64
+ ```
65
+
66
+ ## Quick Start
67
+
68
+ 1. Set your API token:
69
+
70
+ ```bash
71
+ mvsep config set-token YOUR_API_TOKEN
72
+ ```
73
+
74
+ Get your API token from https://mvsep.com/user-api
75
+
76
+ 2. Run a separation task:
77
+
78
+ ```bash
79
+ mvsep run audio.wav -t 49 --add-opt1 5
80
+ ```
81
+
82
+ 3. Or upload and wait manually:
83
+
84
+ ```bash
85
+ mvsep upload audio.wav -t 49 --add-opt1 5 --wait
86
+ ```
87
+
88
+ ## Configuration
89
+
90
+ ```bash
91
+ # Show current config
92
+ mvsep config show
93
+
94
+ # Set default output directory
95
+ mvsep config set-output-dir /path/to/output
96
+
97
+ # Set default output format (1 = wav 16bit)
98
+ mvsep config set-output-format 1
99
+
100
+ # Set polling interval in seconds
101
+ mvsep config set-interval 5
102
+ ```
103
+
104
+ ## Commands
105
+
106
+ | Command | Description |
107
+ |---------|-------------|
108
+ | `mvsep run <file>` | Full workflow: upload + wait + download |
109
+ | `mvsep upload <file>` | Upload and create task |
110
+ | `mvsep status <hash>` | Check task status |
111
+ | `mvsep wait <hash>` | Wait for task completion |
112
+ | `mvsep download <hash>` | Download results |
113
+ | `mvsep list` | List available separation types |
114
+ | `mvsep list --models <type>` | Show models for a separation type |
115
+ | `mvsep history` | Show task history |
116
+ | `mvsep config` | Manage configuration |
117
+
118
+ ## Options
119
+
120
+ Common options for `upload` and `run`:
121
+
122
+ - `-t, --sep-type` - Separation type (use `mvsep list` to see available types)
123
+ - `-f, --output-format` - Output format (default: 1 = wav 16bit)
124
+ - `--add-opt1` - Model option 1
125
+ - `--add-opt2` - Model option 2
126
+ - `-o, --output-dir` - Output directory
127
+ - `-i, --interval` - Polling interval in seconds
128
+ - `--wait` - Wait for completion after upload
129
+ - `--timeout` - Maximum wait time in seconds
130
+
131
+ ## Examples
132
+
133
+ ```bash
134
+ # List popular separation types
135
+ mvsep list --popular
136
+
137
+ # Show models for BS Roformer (type 40)
138
+ mvsep list --models 40
139
+
140
+ # Upload with specific model
141
+ mvsep upload song.wav -t 40 --add-opt1 81 --wait
142
+
143
+ # Download previous results
144
+ mvsep download 20260227153708-abc123-vocals.wav -o ./output
145
+ ```
146
+
147
+ ## Output Formats
148
+
149
+ | Value | Format |
150
+ |-------|--------|
151
+ | 0 | mp3 (320 kbps) |
152
+ | 1 | wav (16 bit) |
153
+ | 2 | flac (16 bit) |
154
+ | 3 | m4a (lossy) |
155
+ | 4 | wav (32 bit) |
156
+ | 5 | flac (24 bit) |
157
+
158
+ ## License
159
+
160
+ MIT License
@@ -0,0 +1,136 @@
1
+ # MVSEP CLI
2
+
3
+ A command-line interface for [MVSEP](https://mvsep.com) music separation API.
4
+
5
+ ## Features
6
+
7
+ - Upload audio files and create separation tasks
8
+ - Monitor task status in real-time
9
+ - Download separated tracks automatically
10
+ - Support for multiple separation algorithms and models
11
+ - Configurable default settings
12
+ - Support for mirror sites (China)
13
+
14
+ ## Installation
15
+
16
+ ```bash
17
+ pip install mvsep-cli
18
+ ```
19
+
20
+ Or install from source:
21
+
22
+ ```bash
23
+ pip install -e .
24
+ ```
25
+
26
+ ## Mirror Sites
27
+
28
+ MVSEP provides mirror sites for better access in different regions:
29
+
30
+ | Mirror | URL |
31
+ |--------|-----|
32
+ | main | https://mvsep.com |
33
+ | mirror | https://mirror.mvsep.com (China) |
34
+
35
+ Set your preferred mirror:
36
+
37
+ ```bash
38
+ mvsep config set-mirror mirror # Use China mirror
39
+ mvsep config set-mirror main # Use main site
40
+ ```
41
+
42
+ ## Quick Start
43
+
44
+ 1. Set your API token:
45
+
46
+ ```bash
47
+ mvsep config set-token YOUR_API_TOKEN
48
+ ```
49
+
50
+ Get your API token from https://mvsep.com/user-api
51
+
52
+ 2. Run a separation task:
53
+
54
+ ```bash
55
+ mvsep run audio.wav -t 49 --add-opt1 5
56
+ ```
57
+
58
+ 3. Or upload and wait manually:
59
+
60
+ ```bash
61
+ mvsep upload audio.wav -t 49 --add-opt1 5 --wait
62
+ ```
63
+
64
+ ## Configuration
65
+
66
+ ```bash
67
+ # Show current config
68
+ mvsep config show
69
+
70
+ # Set default output directory
71
+ mvsep config set-output-dir /path/to/output
72
+
73
+ # Set default output format (1 = wav 16bit)
74
+ mvsep config set-output-format 1
75
+
76
+ # Set polling interval in seconds
77
+ mvsep config set-interval 5
78
+ ```
79
+
80
+ ## Commands
81
+
82
+ | Command | Description |
83
+ |---------|-------------|
84
+ | `mvsep run <file>` | Full workflow: upload + wait + download |
85
+ | `mvsep upload <file>` | Upload and create task |
86
+ | `mvsep status <hash>` | Check task status |
87
+ | `mvsep wait <hash>` | Wait for task completion |
88
+ | `mvsep download <hash>` | Download results |
89
+ | `mvsep list` | List available separation types |
90
+ | `mvsep list --models <type>` | Show models for a separation type |
91
+ | `mvsep history` | Show task history |
92
+ | `mvsep config` | Manage configuration |
93
+
94
+ ## Options
95
+
96
+ Common options for `upload` and `run`:
97
+
98
+ - `-t, --sep-type` - Separation type (use `mvsep list` to see available types)
99
+ - `-f, --output-format` - Output format (default: 1 = wav 16bit)
100
+ - `--add-opt1` - Model option 1
101
+ - `--add-opt2` - Model option 2
102
+ - `-o, --output-dir` - Output directory
103
+ - `-i, --interval` - Polling interval in seconds
104
+ - `--wait` - Wait for completion after upload
105
+ - `--timeout` - Maximum wait time in seconds
106
+
107
+ ## Examples
108
+
109
+ ```bash
110
+ # List popular separation types
111
+ mvsep list --popular
112
+
113
+ # Show models for BS Roformer (type 40)
114
+ mvsep list --models 40
115
+
116
+ # Upload with specific model
117
+ mvsep upload song.wav -t 40 --add-opt1 81 --wait
118
+
119
+ # Download previous results
120
+ mvsep download 20260227153708-abc123-vocals.wav -o ./output
121
+ ```
122
+
123
+ ## Output Formats
124
+
125
+ | Value | Format |
126
+ |-------|--------|
127
+ | 0 | mp3 (320 kbps) |
128
+ | 1 | wav (16 bit) |
129
+ | 2 | flac (16 bit) |
130
+ | 3 | m4a (lossy) |
131
+ | 4 | wav (32 bit) |
132
+ | 5 | flac (24 bit) |
133
+
134
+ ## License
135
+
136
+ MIT License
File without changes