Skip to content
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

README.md documentation error: CLI utility correct use. [BUG] [DOCUMENTATION ERROR] #1897

Open
dpeachpeach opened this issue Mar 23, 2024 · 1 comment
Labels

Comments

@dpeachpeach
Copy link

Before creating an issue
I am running the latest version (15.0.0) from source. I am using fish-shell but I also reproduced this on zsh and bash.

Describe the bug

The current README.md on the Github repository has the command for downloading a youtube video via CLI as:

$ pytube https://youtube.com/watch?v=2lAe1cqCOXo

This returns a token error on zsh, bash, and fish. I was able to fix it by realizing that the URL must be fed into the CLI utility as a string. Thus the correct line in the README.md would be:

$ pytube "https://youtube.com/watch?v=2lAe1cqCOXo"

The playlist example also does not work, that URL should also be a string.

To Reproduce

$ pytube https://youtube.com/watch?v=2lAe1cqCOXo

Running this command using the latest version (15.0.0) without marking the URL as a string will return a tokenization error.

Expected behavior
I expected it to download the video (as per the documentation)

I will attach a PR to this issue that quickly fixes the README docs.

Copy link

Thank you for contributing to PyTube. Please remember to reference Contributing.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant