-
Notifications
You must be signed in to change notification settings - Fork 1.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add uploader_id, uploader_name, and device_id for gmusicapi auth in gmusic plugin #3002
Conversation
Looks cool! And it looks like you've thoroughly investigated what these parameters are for. Can you please add them to the documentation for the plugin? Feel free to leave ones that don't have an obvious use (i.e., uploader_name) undocumented for now. |
Okay, let me know if those additions are good. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good! But I sort of like having the example first in the document—what do you think?
docs/plugins/gmusic.rst
Outdated
auto: yes | ||
email: user@example.com | ||
password: seekrit | ||
**Configuration required before use.** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm—I actually kind of liked having the configuration example up here, since people really will need to do this first. Any particular reason you moved it downward? Can we move it back here to stick with the logical flow of steps?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You got it!
- **device_id**: Unique device ID for authorized devices. | ||
This option only needs to be set if you receive an `InvalidDeviceId` | ||
exception. Below the exception will be a list of valid device IDs. | ||
Default: none. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A proper list of config options is great! Let’s definitely keep this stuff here.
Awesome. One last thing before we merge: could you please add a changelog entry to |
🤙 |
Nicely done. |
gmusicapi
auth uses the MAC address to "register" in Google's service. Runningbeet gmusic-upload
will fail if you use beets on multiple machines because too many MAC addresses will be registered. The fix it to be able to use the same MAC address (anddevice_id
for searching) for all of the machines.uploader_id (optional)
Allow custom
uploader_id
to not reach maximum amount of registered devices. This field should be in the format of a MAC address.From
gmusicapi
method docstring: Linkuploader_name (optional)
May not be necessary, but perhaps in the future.
From
gmusicapi
method docstring: Linkdevice_id (optional)
When running
beet gmusic-songs
from a different machine (with a different MAC address) sometimes you may get this error. Thedevice_id
is generated from the MAC address.You can then change
device_id
in your config to one of the valid device IDs thatgmusicapi
lists for you.config example
Let me know if this is acceptable and I will write something up for the gmusic docs.