adding python webhooks app example (#294)

Add Python + Flask webhooks example

examples/python-webhooks/.gitignore

@@ -0,0 +1,24 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+.next
+
+# testing
+/coverage
+
+# misc
+.DS_Store
+*.pem
+.idea
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# local env files
+.env
+dist

examples/python-webhooks/.sample.env

@@ -0,0 +1,3 @@
+MIRO_CLIENT_ID="<your-client-id>"
+MIRO_CLIENT_SECRET="<your-client-secret>"
+MIRO_REDIRECT_URL="<your-ngrok-url>"

examples/python-webhooks/README.md

@@ -0,0 +1,105 @@
+# Python Webhooks
+
+This app demonstrates how to receive webhook events from your Miro board using Python and Flask. By following this guide, you will set up a local environment, create a webhook subscription, and test receiving events when changes are made on your Miro board.
+
+# 👨🏻‍💻 App Demo
+
+https://github.com/user-attachments/assets/0ccffb46-daab-4fc9-8ff8-f5720237f75a
+
+# 📒 Table of Contents
+
+- [Included Features](#features)
+- [Tools and Technologies](#tools)
+- [Prerequisites](#prerequisites)
+- [Associated Developer Tutorial](#tutorial)
+- [Run the app locally](#run)
+- [Folder Structure](#folder)
+- [Contributing](#contributing)
+- [License](#license)
+
+# ⚙️ Included Features <a name="features"></a>
+
+- [Miro Node Client Library with Python](https://miroapp.github.io/api-clients/python/miro_api.html)
+  - [miro.exchangeCodeForAccessToken()](https://miroapp.github.io/api-clients/python/miro_api.html#Miro.exchange_code_for_access_token)
+  - [miro.isAuthorized()](https://miroapp.github.io/api-clients/python/miro_api.html#Miro.is_authorized)
+  - [miro.getAuthUrl()](https://miroapp.github.io/api-clients/python/miro_api.html#Miro.get_auth_url)
+  - [api.get_all_boards()](https://miroapp.github.io/api-clients/python/miro_api/api_extended.html#MiroApiExtended.get_all_boards)
+
+# 🛠️ Tools and Technologies <a name="tools"></a>
+
+- [Python](https://www.python.org/)
+- [Flask](https://flask.palletsprojects.com/en/3.0.x/)
+
+# ✅ Prerequisites <a name="prerequisites"></a>
+
+- You have a [Miro account](https://miro.com/signup/).
+- You're [signed in to Miro](https://miro.com/login/).
+- Your Miro account has a [Developer team](https://developers.miro.com/docs/create-a-developer-team).
+- Your development environment includes [Python](https://www.python.org/) 3.9 or a later version.
+- Your development environment includes [pip](https://www.python.org/) 24.0 or a later version.
+- Your development environment includes [ngrok](https://ngrok.com/) or something similar.
+
+# 📖 Associated developer tutorial <a name="tutorial"></a>
+
+> To view a more in depth developer tutorial of this app including code explanations, see [Getting started with Miro webhooks using Python](https://developers.miro.com/docs/getting-started-with-webhooks-python) on Miro's Developer documentation.
+
+# 🏃🏽‍♂️ Run the app locally <a name="run"></a>
+
+> It is recommended to use a virtual environment to run this app example. Go to where you `.venv` is located and then run `source ./bin/activate` command. Read more about venvs [here](https://docs.python.org/3/library/venv.html).
+
+1. Create a new Miro app on [developers.miro.com](https://developers.miro.com/). This will take you to the app settings page. There you will find the `MIRO_CLIENT_ID` and `MIRO_CLIENT_SECRET` to be added to your `.env` file. Ensure that your app URL is `http://localhost:5000` since that is what port Flask will be running on.
+
+   - Ensure the `boards:read` scope is selected.
+   - Install the app on your developer team. You will get an **access token** which you will need later to authenticate the creation of your webhook subscription.
+
+2. In a new terminal window, run:
+
+```
+ngrok http 5000
+```
+
+This will output something like this:
+
+```
+Forwarding https:<your-ngrok-url> -> http://localhost:5000
+```
+
+The `https:<your-ngrok-url>` is your `MIRO_REDIRECT_URL` to be used in the `.env` file and then later when calling the API to create a webhook subscription.
+
+3. Rename the `.sample.env` file to `.env` and then add in your `MIRO_CLIENT_ID` and `MIRO_CLIENT_SECRET` from your [developers.miro.com](https://developers.miro.com/) app settings page. Use the `forwarding URL` from the previous step for the `MIRO_REDIRECT_URL` in the .env file. Save the file as `.env` with your new variables.
+
+4. Run `pip install -r requirements.txt` to install dependencies.
+
+5. In a separate terminal from the ngrok terminal (leave ngrok running) go to `app-examples/examples/python-webhooks` directiory. Run `flask --app app run` to start the server. Your server should be running on port 5000.
+
+6. Go to your developer team, and open the board you want to receive webhook events for.
+
+7. In a separate browser tab, open up the API Exporer for the [Create Webhook Subscription endpoint](https://developers.miro.com/reference/create-board-subscription).
+
+8. Provide the following information in the API Explorer:
+
+> **Access Token**: Once you get the access token after installing your app on a developer team (from step 4 above), you can add the access token to the Authorization section of the API reference page.
+>
+> **boardId:** Get the board ID of the board you want to receive notifications for. This board should be in the same team where you installed the app. You can find board ID in the URL when you go to your board: https://miro.com/app/board/<boardId>.
+>
+> **callbackUrl:** This is the URL where you will receive events. It should be the same as `MIRO_REDIRECT_URL` in `.env`. 9. Select Try It! to run the API request right from the browser. If you get a 201 response, you are ready to receive events!
+
+9. Next, go to to the same board which you referenced in the request above, and create a sticky. You should now receive a webhook event! Great job! You've just learned how to get started with Miro's webhooks with Python 🎉.
+
+# 🗂️ Folder structure <a name="folder"></a>
+
+```
+.
+├── app.py - main logic to receive webhooks and start the server
+├── .sample.env <-- File with sample env variables. Need to rename to .env and then add in your variables.
+├── app-manifest.yaml <-- File with sample manifest file for easy copy paste into your developer app settings manifest.
+├── requirements.txt <-- File with libraries which the project depends on, including versions.
+```
+
+# 🫱🏻‍🫲🏽 Contributing <a name="contributing"></a>
+
+If you want to contribute to this example, or any other Miro Open Source project, please review [Miro's contributing guide](https://github.com/miroapp/app-examples/blob/main/CONTRIBUTING.md).
+
+# 🪪 License <a name="license"></a>
+
+[MIT License](https://github.com/miroapp/app-examples/blob/main/LICENSE).

examples/python-webhooks/app-manifest.yaml

@@ -0,0 +1,5 @@
+# See https://developers.miro.com/docs/app-manifest on how to use this
+appName: Python Webhooks
+sdkUri: "http://localhost:5000"
+scopes:
+  - boards:read

examples/python-webhooks/app.py

@@ -0,0 +1,53 @@
+from flask import Flask, session, request, json, Response
+from miro_api import Miro
+from miro_api.storage import Storage
+
+from dotenv import load_dotenv
+
+load_dotenv()
+
+app = Flask(__name__)
+
+app.secret_key = b"very_random_secret"
+
+
+class SessionStorage(Storage):
+    session_key = "miro_state"
+
+    def get(self):
+        return session[self.session_key]
+
+    def set(self, state):
+        if not state:
+            session.pop(self.session_key, None)
+            return
+        session[self.session_key] = state
+
+
+miro = Miro(storage=SessionStorage())
+
+
+def render_boards():
+    boards = miro.api.get_all_boards()
+    names = "<br/>".join([board.name for board in boards])
+    return f"<p>List of boards in the team: {names}</p>"
+
+
+@app.route("/", methods=["GET", "POST"])
+def hello_world():
+    if request.method == "GET":
+        if miro.is_authorized:
+            return render_boards()
+
+        if code := request.args.get("code", ""):
+            miro.exchange_code_for_access_token(code)
+            return render_boards()
+
+        return f"<a href='{miro.auth_url}'>Login to Miro</a>"
+    if request.method == "POST":
+        webhook_data = request.json
+        formatted_webhook_data = json.dumps(webhook_data, indent=4)
+        print(f"webhook event: {formatted_webhook_data}")
+        return Response(
+            json.dumps(webhook_data), status=200, mimetype="application/json"
+        )

examples/python-webhooks/requirements.txt

@@ -0,0 +1,3 @@
+Flask==3.0.3
+miro_api==2.2.0
+python-dotenv==1.0.1