Skip to content

Commit

Permalink
chore: add file argument examples
Browse files Browse the repository at this point in the history
  • Loading branch information
MatteoGuadrini committed Nov 21, 2024
1 parent 31b4651 commit 6a03e89
Showing 1 changed file with 30 additions and 22 deletions.
52 changes: 30 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@ $ pip install . # for others
| -t | --title | Playlist title | Title string |
| -g | --encoding | Text encoding | UTF-8,ASCII,UNICODE |
| -I | --image | Playlist image | Image path |
| -l | --link | Add local or remote files | Files |
| -l | --link | Add remote file links | Http links |
| -F | --file | Add files | Files |
| -j | --join | Join one or more other playlist files | Playlist files |
| -n | --cache | Cache playlist results | Seconds |
| -U | --url-chars | Substitute some chars with URL Encoding | |
Expand Down Expand Up @@ -61,81 +62,88 @@ $ pip install . # for others
cd myalbum
mkpl myalbum.m3u
```

2. Create a playlist for one music album and add other multimedia files (`-F` option):

```bash
cd myalbum_special
mkpl myalbum_special.m3u -F music_video.mp4 other_stuff/song1.mp3 other_stuff/song2.mp3
```

2. Create a playlist of a film saga
3. Create a playlist of a film saga

```bash
mkpl -d HarryPotter -f mkv HP_saga.m3u
```

3. Create a shuffled playlist with my music collection; include only files with minimum size of 2 Megabyte
4. Create a shuffled playlist with my music collection; include only files with minimum size of 2 Megabyte

```bash
mkpl -d "my_mp3_collection" "my_mp4_collection" -rs -z 2mb "my music.m3u"
```

4. Create a shuffled playlist with my music collection and exclude dirs
5. Create a shuffled playlist with my music collection and exclude dirs

```bash
mkpl -d "my_mp3_collection" "my_mp4_collection" -r -s -e "my_mp3_collection/metallica" "my_mp3_collection/dk" -- "my music.m3u"
```

5. Create a TV series playlist with max 15 tracks
6. Create a TV series playlist with max 15 tracks

```bash
mkpl -d "my_series/GOT" -m 15 "got_first_15.m3u"
```

6. Add into _my music_ playlist new songs and don't add same file
7. Add into _my music_ playlist new songs and don't add same file
```bash
mkpl -d "new_collection" -rsu "my music.m3u" -a
```
7. Create playlist with music and video files if files is greater then 10MB
8. Create playlist with music and video files if files is greater then 10MB
```bash
mkpl -d "my_files" -r -z 10485760 "multimedia.m3u"
```
8. Create playlist with only number one and two tracks with regular expression
9. Create playlist with only number one and two tracks with regular expression
```bash
mkpl -d "my_mp3_collection" -r -p "^[12]|[012]{2}" "my music.m3u"
```
9. Create a playlist for one music album and set the title:
10. Create a playlist for one music album and set the title:
```bash
cd myalbum
mkpl myalbum.m3u -t "My Album"
```
```bash
cd myalbum
mkpl myalbum.m3u -t "My Album"
```
10. Create a playlist and add _UTF-8_ encoding
11. Create a playlist and add _UTF-8_ encoding
```bash
mkpl -d "new_collection" -r "my music.m3u" -g "UTF-8"
```
11. Create a playlist and set image
12. Create a playlist and set image
```bash
mkpl -d "new_collection" -r "my music.m3u" -I "new_collection/playlist_cover.jpg"
```
12. Create a playlist and add remote file links
13. Create a playlist and add remote file links
```bash
mkpl -d "new_collection" -r "my music.m3u" -l http://192.168.1.123/mp3/song1.mp3, http://192.168.1.123/mp3/song2.mp4
```
13. Create a playlist and set Windows backslash (\\) folder separator (for Windows OS)
14. Create a playlist and set Windows backslash (\\) folder separator (for Windows OS)
```bash
mkpl -d "new_collection" -r "my music.m3u" -w
```
14. Split playlist into _N_ playlists fon _N_ directories
15. Split playlist into _N_ playlists fon _N_ directories
```bash
mkpl -d "folder1" "folder2" "folder3" -r "my_music.m3u" -S
Expand All @@ -150,7 +158,7 @@ $ pip install . # for others
...
```
15. Sort playlist files by name (`-o`), by creation date (`-O`), by track number (`-T`), by year (`-y`), by size (`-Z`) or by length (`-L`):
16. Sort playlist files by name (`-o`), by creation date (`-O`), by track number (`-T`), by year (`-y`), by size (`-Z`) or by length (`-L`):
```bash
mkpl -d "new_collection" -r "my music.m3u" -o
Expand All @@ -161,20 +169,20 @@ $ pip install . # for others
mkpl -d "new_collection" -r "my music.m3u" -L
```
16. Join the _"First playlist.m3u"_ and _"Second playlist.m3u8"_ with new **"Third playlist.m3u"**:
17. Join the _"First playlist.m3u"_ and _"Second playlist.m3u8"_ with new **"Third playlist.m3u"**:
```bash
mkpl -d "new_collection" -r "Third playlist" -j "First playlist.m3u" "Second playlist.m3u8"
```
17. Counts the multimedia files:
18. Counts the multimedia files:
```console
mkpl -d "new_collection" -r "My new collection" -C
4023
```
18. Asks confirmation for every file into folders:
19. Asks confirmation for every file into folders:
```console
mkpl -d "new_collection" -r "My new collection" -R
Expand Down

0 comments on commit 6a03e89

Please sign in to comment.