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

Add Python script documentation to docs #21582

Closed
mvbattista opened this issue Jun 30, 2019 · 2 comments
Closed

Add Python script documentation to docs #21582

mvbattista opened this issue Jun 30, 2019 · 2 comments
Labels

Comments

@mvbattista
Copy link

@mvbattista mvbattista commented Jun 30, 2019

Checklist

  • I'm reporting a feature request
  • I've verified that I'm running youtube-dl version 2019.06.27
  • I've searched the bugtracker for similar feature requests including closed ones

Description

For use in a python script, parameters are different than those listed in README.md for command line usage. For example, in README.md:

    --cookies FILE                   File to read cookies from and dump cookie
                                     jar in

When trying to call in a standalone Python script importing youtube_dl, the same functionality is passed in the 'cookiefile' argument.

with youtube_dl.YoutubeDL({'cookiefile': '/path/to/cookies.txt'}) as ytdl:

Documentation on the translation between command line arguments and Python object instantiation arguments will help developers as opposed to searching through library source code.

@mvbattista mvbattista added the request label Jun 30, 2019
@dstftw
Copy link
Collaborator

@dstftw dstftw commented Jun 30, 2019

List of available programmatic options is clearly mentioned in embedding guide.

@dstftw dstftw closed this Jun 30, 2019
@mvbattista
Copy link
Author

@mvbattista mvbattista commented Jun 30, 2019

@dstftw So why can't this in-code documentation be moved to a separate embedding Markdown file?

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

Successfully merging a pull request may close this issue.

None yet
2 participants
You can’t perform that action at this time.