You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Oct 20, 2018. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+5-36
Original file line number
Diff line number
Diff line change
@@ -3,53 +3,22 @@ gmusicapi-scripts
3
3
4
4
A collection of scripts for [gmusicapi](https://github.com/simon-weber/Unofficial-Google-Music-API) using [gmusicapi-wrapper](https://github.com/thebigmunch/gmusicapi-wrapper).
* ffmpeg or avconv for uploading non-mp3 files (See [here](http://unofficial-google-music-api.readthedocs.org/en/latest/usage.html#usage))
7
+
## Documentation
14
8
15
-
## Installation
9
+
Documentation is available online at <https://thebigmunch.github.io/gmusicapi-scripts>. There you can find [install instructions](https://thebigmunch.github.io/gmusicapi-scripts/install/), [usage instructions](https://thebigmunch.github.io/gmusicapi-scripts/usage/), and [contributing guidelines](https://thebigmunch.github.io/gmusicapi-scripts/contributing/).
See the [USAGE.md](https://github.com/thebigmunch/gmusicapi-scripts/blob/master/USAGE.md) file or the online [Wiki](https://github.com/thebigmunch/gmusicapi-scripts/wiki)
29
-
30
-
## Contributing
31
-
32
-
See the [CONTRIBUTING.md](https://github.com/thebigmunch/gmusicapi-scripts/blob/master/CONTRIBUTING.md) file
33
-
34
-
## FAQ
35
-
36
-
##### Is it possible to add support for downloading All Access songs?
37
-
38
-
Yes.
39
-
40
-
##### Would you add support for downloading All Access songs?
41
-
42
-
Almost certainly never. All Access songs are obviously not intended for download. Your All Access subscription allows you to stream these songs as long as you subscribe. Circumventing this restriction would only bring unwanted attention, criticism, and repercussions to gmusicapi.
43
11
44
12
## Contact
45
13
46
14
You can contact the author in ``#gmusicapi`` on ``irc.freenode.net`` or by [e-mail](mailto:[email protected])
47
15
16
+
48
17
## Donate
49
18
50
-
Donations, as any compliment, are appreciated but not expected.
19
+
Donations, as any compliment, are appreciated but not expected. I include these because people have shown interest.
Notable changes for the [gmusicapi-scripts](https://github.com/thebigmunch/gmusicapi-scripts) project. This project uses [Semantic Versioning](http://semver.org/) principles.
Bug reports and feature requests can be submitted to the [Issue Tracker](https://github.com/thebigmunch/gmusicapi-scripts/issues).
4
+
5
+
Some general guidelines to follow:
6
+
7
+
* Use an appropriate, descriptive title.
8
+
* Provide as many details as possible.
9
+
* Don't piggy-back. Keep separate topics in separate issues.
10
+
11
+
## Submitting code
12
+
13
+
Patches are welcome. Keep your code consistent with the rest of the project. [PEP8](https://www.python.org/dev/peps/pep-0008/) is a good guide, but with the following specific exceptions to keep in mind for coding/linting:
14
+
15
+
* Tabs should be used for indentation of code.
16
+
* I don't have a set maximum line length. However, I do like to keep lines viewable in my editor when windowed (150).
17
+
18
+
Some linter errors may need to be ignored to accommodate these differences.
19
+
20
+
For simple, single file changes/additions, sending or linking your modified file is acceptable. For complex, multiple file changes, creating a diff file or using GitHub's [Pull Request](https://help.github.com/articles/using-pull-requests/) feature is preferable.
21
+
22
+
If you have any questions or concerns, contact me through the methods listed below.
23
+
24
+
### Pull Requests
25
+
26
+
You should create a separate [feature branch][fb] in your [fork][fork] to commit your changes to. [Pull Requests](https://help.github.com/articles/creating-a-pull-request) will only be accepted if made from a [feature branch][fb] and against the [devel](https://github.com/thebigmunch/gmusicapi-scripts/tree/devel) branch of this repository.
27
+
28
+
Commit messages should be written in a [well-formed, consistent](https://sethrobertson.github.io/GitBestPractices/#usemsg) manner. See the [commit log](https://github.com/thebigmunch/gmusicapi-scripts/commits/devel) for acceptable examples.
29
+
30
+
Each commit should encompass the smallest logical changeset (e.g. changing two unrelated things in the same file would be two commits rather than one commit of "Change filename".) If you made a mistake in a commit in your Pull Request, you should [amend](https://www.atlassian.com/git/tutorials/rewriting-history/git-commit--amend) or [rebase](https://www.atlassian.com/git/tutorials/rewriting-history/git-rebase-i) to change your previous commit(s) then [force push](http://stackoverflow.com/a/12610763) to the [feature branch][fb] in your [fork][fork].
A collection of scripts for [gmusicapi](https://github.com/simon-weber/gmusicapi) using [gmusicapi-wrapper](https://github.com/thebigmunch/gmusicapi-wrapper).
2
+
3
+
## FAQ
4
+
5
+
**Is it possible to add support for downloading All Access songs?**
6
+
7
+
Yes.
8
+
9
+
**Would you add support for downloading All Access songs?**
10
+
11
+
Almost certainly never. All Access songs are obviously not intended for download. Your All Access subscription allows you to stream these songs as long as you subscribe. Circumventing this restriction would only bring unwanted attention, criticism, and repercussions to gmusicapi.
12
+
13
+
14
+
## Contact
15
+
16
+
You can contact the author in ``#gmusicapi`` on ``irc.freenode.net`` or by [e-mail](mailto:[email protected])
17
+
18
+
19
+
## Donate
20
+
21
+
Donations, as any compliment, are appreciated but not expected. I include these because people have shown interest.
-q, --quiet | Don't output status messages<br>With -l,--log will display gmusicapi warnings
48
-
-f, --include-filter | Include Google songs by field:pattern filter (e.g. "artist:Muse").*<br>Values can be any valid [Python regex pattern](http://docs.python.org/2/library/re.html)<br>This option can be set multiple times
49
-
-F, --exclude-filter | Exclude Google songs by field:pattern filter (e.g. "artist:Muse").*<br>Values can be any valid [Python regex pattern](http://docs.python.org/2/library/re.html)<br>This option can be set multiple times
37
+
-f, --include-filter | Include Google songs by field:pattern filter (e.g. "artist:Muse").*<br>Values can be any valid [Python regex pattern](http://docs.python.org/3/library/re.html)<br>This option can be set multiple times
38
+
-F, --exclude-filter | Exclude Google songs by field:pattern filter (e.g. "artist:Muse").*<br>Values can be any valid [Python regex pattern](http://docs.python.org/3/library/re.html)<br>This option can be set multiple times
50
39
-a, --all-includes | Songs must match all include filter criteria
51
40
-A, --all-excludes | Songs must match all exclude filter criteria
52
41
-y, --yes | Display results without asking for confirmation
@@ -68,8 +57,8 @@ Options | Description
68
57
-l, --log | Enable gmusicapi logging
69
58
-d, --dry-run | Output list of songs that would be uploaded and excluded
70
59
-q, --quiet | Don't output status messages<br>With -l,--log will display gmusicapi warnings
71
-
-f, --include-filter | Include Google songs by field:pattern filter (e.g. "artist:Muse").*<br>Values can be any valid [Python regex pattern](http://docs.python.org/2/library/re.html)<br>This option can be set multiple times
72
-
-F, --exclude-filter | Exclude Google songs by field:pattern filter (e.g. "artist:Muse").*<br>Values can be any valid [Python regex pattern](http://docs.python.org/2/library/re.html)<br>This option can be set multiple times
60
+
-f, --include-filter | Include Google songs by field:pattern filter (e.g. "artist:Muse").*<br>Values can be any valid [Python regex pattern](http://docs.python.org/3/library/re.html)<br>This option can be set multiple times
61
+
-F, --exclude-filter | Exclude Google songs by field:pattern filter (e.g. "artist:Muse").*<br>Values can be any valid [Python regex pattern](http://docs.python.org/3/library/re.html)<br>This option can be set multiple times
73
62
-a, --all-includes | Songs must match all include filter criteria
74
63
-A, --all-excludes | Songs must match all exclude filter criteria
75
64
-y, --yes | Display results without asking for confirmation
@@ -100,8 +89,8 @@ Options | Description
100
89
-R, --no-recursion | Disable recursion when scanning for local files.<br>This is equivalent to setting --max-depth to 0.
101
90
--max-depth DEPTH | Set maximum depth of recursion when scanning for local files.<br>Default is infinite recursion.<br>Has no effect when -R, --no-recursion set.
102
91
-e, -exclude | Exclude file paths matching a Python regex pattern<br>This option can be set multiple times
103
-
-f, --include-filter | Include Google songs (download) or local songs (upload) by field:pattern filter (e.g. "artist:Muse").*<br>Values can be any valid [Python regex pattern](http://docs.python.org/2/library/re.html)<br>This option can be set multiple times
104
-
-F, --exclude-filter | Exclude Google songs (download) or local songs (upload) by field:pattern filter (e.g. "artist:Muse").*<br>Values can be any valid [Python regex pattern](http://docs.python.org/2/library/re.html)<br>This option can be set multiple times
92
+
-f, --include-filter | Include Google songs (download) or local songs (upload) by field:pattern filter (e.g. "artist:Muse").*<br>Values can be any valid [Python regex pattern](http://docs.python.org/3/library/re.html)<br>This option can be set multiple times
93
+
-F, --exclude-filter | Exclude Google songs (download) or local songs (upload) by field:pattern filter (e.g. "artist:Muse").*<br>Values can be any valid [Python regex pattern](http://docs.python.org/3/library/re.html)<br>This option can be set multiple times
105
94
-a, --all-includes | Songs must match all include filter criteria
106
95
-A, --all-excludes | Songs must match all exclude filter criteria
107
96
input | Files, directories, or glob patterns to upload<br>Defaults to current directory if omitted
@@ -148,8 +137,8 @@ Options | Description
148
137
-R, --no-recursion | Disable recursion when scanning for local files.<br>This is equivalent to setting --max-depth to 0.
149
138
--max-depth DEPTH | Set maximum depth of recursion when scanning for local files.<br>Default is infinite recursion.<br>Has no effect when -R, --no-recursion set.
150
139
-e, -exclude | Exclude file paths matching a Python regex pattern<br>This option can be set multiple times
151
-
-f, --include-filter | Include local songs by field:pattern filter (e.g. "artist:Muse").*<br>Values can be any valid [Python regex pattern](http://docs.python.org/2/library/re.html)<br>This option can be set multiple times
152
-
-F, --exclude-filter | Exclude local songs by field:pattern filter (e.g. "artist:Muse").*<br>Values can be any valid [Python regex pattern](http://docs.python.org/2/library/re.html)<br>This option can be set multiple times
140
+
-f, --include-filter | Include local songs by field:pattern filter (e.g. "artist:Muse").*<br>Values can be any valid [Python regex pattern](http://docs.python.org/3/library/re.html)<br>This option can be set multiple times
141
+
-F, --exclude-filter | Exclude local songs by field:pattern filter (e.g. "artist:Muse").*<br>Values can be any valid [Python regex pattern](http://docs.python.org/3/library/re.html)<br>This option can be set multiple times
153
142
-a, --all-includes | Songs must match all include filter criteria
154
143
-A, --all-excludes | Songs must match all exclude filter criteria
155
144
input | Files, directories, or glob patterns to upload<br>Defaults to current directory if omitted
@@ -180,8 +169,8 @@ Options | Description
180
169
-l, --log | Enable gmusicapi logging
181
170
-d, --dry-run | Output list of songs that would be uploaded and excluded
182
171
-q, --quiet | Don't output status messages<br>With -l,--log will display gmusicapi warnings<br>With -d,--dry-run will display song list
183
-
-f, --include-filter | Include Google songs by field:pattern filter (e.g. "artist:Muse").*<br>Values can be any valid [Python regex pattern](http://docs.python.org/2/library/re.html)<br>This option can be set multiple times
184
-
-F, --exclude-filter | Exclude Google songs by field:pattern filter (e.g. "artist:Muse").*<br>Values can be any valid [Python regex pattern](http://docs.python.org/2/library/re.html)<br>This option can be set multiple times
172
+
-f, --include-filter | Include Google songs by field:pattern filter (e.g. "artist:Muse").*<br>Values can be any valid [Python regex pattern](http://docs.python.org/3/library/re.html)<br>This option can be set multiple times
173
+
-F, --exclude-filter | Exclude Google songs by field:pattern filter (e.g. "artist:Muse").*<br>Values can be any valid [Python regex pattern](http://docs.python.org/3/library/re.html)<br>This option can be set multiple times
185
174
-a, --all-includes | Songs must match all include filter criteria
186
175
-A, --all-excludes | Songs must match all exclude filter criteria
187
176
output | Output file or directory name which can include template patterns<br>Defaults to name suggested by Google Music in your current directory
@@ -194,4 +183,3 @@ output | Output file or directory name which can include templat
194
183
gmdownload -a -f 'artist:Muse' -f 'album:Black Holes' "/path/to/%artist%/%album%/%title%"
0 commit comments