diff --git a/docs/usage.rst b/docs/usage.rst index fd670c1..18e4b00 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -52,3 +52,30 @@ Exceptions .. autoexception:: ytubeinsight.YTubeInsightError :members: + +Getting a YouTube Data API Key +------------------------------ + +To use YTubeInsight, you need a YouTube Data API key. Here's how to get one: + +1. Go to the `Google Developers Console `_. +2. Create a new project or select an existing one. +3. Enable the YouTube Data API v3 for your project. +4. Create credentials (API key) for your project. +5. Use this API key in your YTubeInsight calls. + +Remember to keep your API key secret and never share it publicly. + +Error Handling +-------------- + +YTubeInsight uses custom exceptions to handle errors. Here's an example of how to handle errors: + +.. code-block:: python + + from ytubeinsight import analyze_channel, YTubeInsightError + + try: + result = analyze_channel('https://www.youtube.com/channel/UC_x5XG1OV2P6uZZ5FSM9Ttw', API_KEY) + except YTubeInsightError as e: + print(f"An error occurred: {str(e)}")