Skip to content

Conversation

@SapiensAnatis
Copy link
Contributor

Document the process for running the examples. This was fairly non-obvious and I spent a fair bit of time trying and failing to get a client credentials token to work before finding in some discussion that this is known not to work.

The wiki mentions using the oauth example as a way to get a token and I think that is likely to be the best way to get a token for the purposes of running the examples too.


I was able to get all of the examples except one to work using the method described, although for play_connect this is irrelevant since it acquires its own token via OAuth. The one I wasn't able to get to work was get_token which seems to be broken as per #1532, however this does work if you make the suggested fix to use login5().

@photovoltex photovoltex requested a review from Copilot September 7, 2025 20:17
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds comprehensive documentation for running examples in the librespot library, addressing a gap in user guidance. The documentation clarifies the token acquisition process and provides step-by-step instructions for running examples.

  • Adds a new README.md file in the examples directory with detailed usage instructions
  • Documents the OAuth-based token acquisition process as the recommended approach
  • Provides concrete examples of how to run the examples with proper arguments

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Document the process for running the examples. This was fairly
non-obvious and I spent a fair bit of time trying and failing to get
a client credentials token to work before finding in some discussion
that this is known not to work.

The wiki mentions using the oauth example as a way to get a token
and I think that is likely to be the best way to get a token for the
purposes of running the examples too.
@photovoltex photovoltex merged commit 0e5531f into librespot-org:dev Sep 9, 2025
paulfariello pushed a commit to paulfariello/librespot that referenced this pull request Sep 23, 2025
Document the process for running the examples. This was fairly
non-obvious and I spent a fair bit of time trying and failing to get
a client credentials token to work before finding in some discussion
that this is known not to work.

The wiki mentions using the oauth example as a way to get a token
and I think that is likely to be the best way to get a token for the
purposes of running the examples too.
@SapiensAnatis SapiensAnatis deleted the docs/document-examples branch November 11, 2025 19:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants