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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

youtube documentation update #8682

Merged
merged 5 commits into from
Jan 30, 2024
Merged

Conversation

QuantumPlumber
Copy link
Contributor

Description

Documentation update to reflect the YouTube handler Readme.md. I assume that the read me is up to date.

Fixes #8667

Type of change

  • [ x ] 馃搫 This change requires a documentation update

Checklist:

  • [ x ] My code follows the style guidelines(PEP 8) of MindsDB.
  • [ x ] I have appropriately commented on my code, especially in complex areas.
  • [ x ] Necessary documentation updates are either made or tracked in issues.
  • [ x ] Relevant unit and integration tests are updated or added.

docs/integrations/app-integrations/youtube.mdx Outdated Show resolved Hide resolved
docs/integrations/app-integrations/youtube.mdx Outdated Show resolved Hide resolved
docs/integrations/app-integrations/youtube.mdx Outdated Show resolved Hide resolved
docs/integrations/app-integrations/youtube.mdx Outdated Show resolved Hide resolved
docs/integrations/app-integrations/youtube.mdx Outdated Show resolved Hide resolved
Copy link
Contributor

@MinuraPunchihewa MinuraPunchihewa left a comment

Choose a reason for hiding this comment

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

Hey Ave!
Thank you for this. There is a small update that we need to make to the Connection section, specifically to the parameters that are used to initialize the handler. It is now possible to pass OAuth credentials (generated through the GCP console) as a URL, file path and even upload it directly (when using the form).

P.S: You have the coolest username!

@martyna-mindsdb
Copy link
Contributor

Hey @MinuraPunchihewa @QuantumPlumber
I'm waiting until the credentials_file param is supported, and also, until OAuth2 (credentials_url) is deployed.
Then, I plan to update yt docs to include OAuth2.

pip install mindsdb[youtube]
```

## Usage
Copy link
Contributor

Choose a reason for hiding this comment

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

Please remove this "## Usage" from this line.

The Connection section ends after the CREATE DATABASE statement. And there is already the Usage section.

SELECT * FROM mindsdb_youtube.get_comments
WHERE youtube_video_id = "raWFGQ20OfA";
```
~~~~sql
Copy link
Contributor

Choose a reason for hiding this comment

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

Please change it back to triple backticks as above.

```sql
SELECT * FROM mindsdb_youtube.get_comments
WHERE youtube_video_id = "raWFGQ20OfA"
~~~~sql
Copy link
Contributor

Choose a reason for hiding this comment

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

Please change it back to triple backticks as above.


Get information about any youtube video using video_id:
```sql
~~~~sql
Copy link
Contributor

Choose a reason for hiding this comment

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

Please change it back to triple backticks as above.


Get information about any YouTube video using video_id:

~~~~sql
Copy link
Contributor

Choose a reason for hiding this comment

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

Please change it back to triple backticks as above.

</Tip>

The first step is to create a database with the new `Youtube` engine using the following command:
The first step is to create a database with the new ```youtube``` engine using the following command:
Copy link
Contributor

Choose a reason for hiding this comment

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

The inline code uses single backticks. So it should be "...with the new `youtube` engine..."

@MinuraPunchihewa MinuraPunchihewa merged commit cbf3a8e into staging Jan 30, 2024
7 checks passed
@StpMax StpMax mentioned this pull request Feb 19, 2024
@hamishfagg hamishfagg deleted the youtube_documentation branch June 10, 2024 21:32
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.

[Docs]: Update the Documentation for the YouTube Integration
3 participants