chore: add python readme

packages/components/CoreMethods.js

@@ -0,0 +1,32 @@
+import { Text } from '@asyncapi/generator-react-sdk';
+
+export function CoreMethods({ language }) {
+  const msgHandler =
+    language === 'python'
+      ? 'register_message_handler(handler_function)'
+      : 'registerMessageHandler(handlerFunction)';
+
+  const errHandler =
+    language === 'python'
+      ? 'register_error_handler(handler_function)'
+      : 'registerErrorHandler(handlerFunction)';
+
+  return (
+    <Text newLines={2}>
+      {`## API
+
+### \`connect()\`
+Establishes a WebSocket connection.
+
+### \`${msgHandler}\`
+Registers a callback for incoming messages.
+
+### \`${errHandler}\`
+Registers a callback for connection errors.
+
+### \`close()\`
+Closes the WebSocket connection.
+`}
+    </Text>
+  );
+}

packages/components/Info.js

@@ -0,0 +1,11 @@
+import { getClientName, getServer, getServerUrl, getInfo, getTitle } from '@asyncapi/generator-helpers';
+
+export function BaseInfo(asyncapi, params) {
+  const server = getServer(asyncapi.servers(), params.server);
+  const info = getInfo(asyncapi);
+  const clientName = getClientName(asyncapi, params.appendClientSuffix, params.customClientName);
+  const title = getTitle(asyncapi);
+  const serverUrl = getServerUrl(server);
+
+  return { server, info, clientName, title, serverUrl };
+}

packages/components/Installation.js

@@ -0,0 +1,16 @@
+import { Text } from '@asyncapi/generator-react-sdk';
+
+export function Installation() {
+  return (
+    <Text newLines={2}>
+      {`## Installation
+
+Install dependencies:
+
+\`\`\`bash
+pip install -r requirements.txt
+\`\`\`
+`}
+    </Text>
+  );
+}

packages/components/Overview.js

@@ -0,0 +1,16 @@
+import { Text } from '@asyncapi/generator-react-sdk';
+
+export function Overview({ info, title, serverUrl }) {
+  return (
+    <Text newLines={2}>
+      {`## Overview
+
+${info.description() || `A WebSocket client for ${title}.`}
+
+- **Version:** ${info.version()}
+- **Server URL:** ${serverUrl}
+`}
+    </Text>
+  );
+}
+

packages/components/Usage.js

@@ -0,0 +1,46 @@
+import { Text } from '@asyncapi/generator-react-sdk';
+
+export function Usage({ clientName, clientFileName, language }) {
+  let snippet = '';
+
+  if (language === 'python') {
+    snippet = `
+from ${clientFileName.replace('.py', '')} import ${clientName}
+
+ws_client = ${clientName}()
+
+async def main():
+    await ws_client.connect()
+    # use ws_client to send/receive messages
+    await ws_client.close()
+`;
+  } else if (language === 'javascript') {
+    snippet = `
+const ${clientName} = require('./${clientFileName.replace('.js', '')}');
+const wsClient = new ${clientName}();
+
+async function main() {
+  try {
+    await wsClient.connect();
+    // use wsClient to send/receive messages
+    await wsClient.close();
+  } catch (error) {
+    console.error('Failed to connect:', error);
+  }
+}
+
+main();
+`;
+  }
+
+  return (
+    <Text newLines={2}>
+      {`## Usage
+
+\`\`\`${language}
+${snippet.trim()}
+\`\`\`
+`}
+    </Text>
+  );
+}

packages/templates/clients/websocket/javascript/components/AvailableOperations.js

@@ -9,8 +9,8 @@ export function AvailableOperations({ operations }) {
   return (
     <>
       <Text newLines={2}>### Available Operations</Text>
-      {operations.map((operation) => (
-        <Text newLines={2}>
+      {operations.map((operation, index) => (
+        <Text key={index} newLines={2}>
           <OperationHeader operation={operation} />
           <MessageExamples operation={operation} />
         </Text>

packages/templates/clients/websocket/javascript/template/README.md.js

@@ -1,106 +1,30 @@
 import { File, Text } from '@asyncapi/generator-react-sdk';
-import { getClientName, getServer, getServerUrl, getInfo, getTitle } from '@asyncapi/generator-helpers';
+import { BaseInfo } from '../../../../../components/Info';
+import { Overview } from '../../../../../components/Overview';
+import { CoreMethods } from '../../../../../components/CoreMethods';
+import { Usage } from '../../../../../components/Usage';
 import { AvailableOperations } from '../components/AvailableOperations';
 
 export default function({ asyncapi, params }) {
-  const server = getServer(asyncapi.servers(), params.server);
-  const info = getInfo(asyncapi);
-  const clientName = getClientName(asyncapi, params.appendClientSuffix, params.customClientName);
-  const title = getTitle(asyncapi);
-  const serverUrl = getServerUrl(server);
+  const { info, clientName, title, serverUrl } = BaseInfo(asyncapi, params);
 
   const operations = asyncapi.operations().all();
-  
+
   return (
     <File name="README.md">
-      <Text newLines={2}>
-        {`# ${title} 
-
-## Overview
-
-${info.description() || `A WebSocket client for ${title}.`}
-
-- **Version:** ${info.version()}
-- **URL:** ${serverUrl}
-
-
-## Client API Reference
-
-\`\`\`javascript
-const ${clientName} = require('./${params.clientFileName.replace('.js', '')}');
-const wsClient = new ${clientName}();
-\`\`\`
-
-Here the wsClient is an instance of the \`${clientName}\` class.
-### Core Methods
-
-#### \`connect()\`
-Establishes a WebSocket connection to the server.
-
-#### \`registerMessageHandler(handlerFunction)\`
-Registers a callback to handle incoming messages.
-- **Parameter:** \`handlerFunction\` - This Function takes a parameter \`message\` which is a string. 
-
-#### \`registerErrorHandler(handlerFunction)\`
-Registers a callback to handle WebSocket errors.
-- **Parameter:** \`handlerFunction\` - This Function takes a parameter \`error\` which is an object
-
-#### \`close()\`
-Closes the WebSocket connection.`}
-      </Text>
-      <AvailableOperations operations={operations} />
-      <Text newLines={2}>
-        {`## Testing the client
-
-\`\`\`javascript
-const ${clientName} = require('./${params.clientFileName.replace('.js', '')}');
-const wsClient = new ${clientName}();
-
-
-// Example of how custom message handler that operates on incoming messages can look like
-
-function myHandler(message) {
-  console.log('====================');
-  console.log('Just proving I got the message in myHandler:', message);
-  console.log('====================');  
-}
-
-// Example of custom error handler
-
-function myErrorHandler(error) {
-  console.error('Errors from Websocket:', error.message);
-}
-
-async function main() {
-  wsClient.registerMessageHandler(myHandler);
-  wsClient.registerErrorHandler(myErrorHandler);
-
-  try {
-    await wsClient.connect();
-
-    // Loop to send messages every 5 seconds
-    const interval = 5000; // 5 seconds
-    const message = 'Hello, Echo!';
-
-    while (true) {
-      try {
-        await wsClient.sendEchoMessage(message);
-      } catch (error) {
-        console.error('Error while sending message:', error);
-      }
-      // Wait for the interval before sending the next message
-      await new Promise(resolve => setTimeout(resolve, interval));
-    }
-  } catch (error) {
-    console.error('Failed to connect to WebSocket:', error.message);
-  }
-}
-
-main();
-\`\`\`
-
-`}
-      </Text>
+      <>
+        <Text newLines={2}>
+          {`# ${title}`}
+        </Text>
+        <Overview info={info} title={title} serverUrl={serverUrl} />
+        <Usage
+          clientName={clientName}
+          clientFileName={params.clientFileName}
+          language="javascript"
+        />
+        <CoreMethods language="javascript" />
+        <AvailableOperations operations={operations} />
+      </>
     </File>
   );
-}
+}

packages/templates/clients/websocket/python/template/README.md.js

@@ -0,0 +1,20 @@
+import { File, Text } from '@asyncapi/generator-react-sdk';
+import { BaseInfo } from '../../../../../components/Info';
+import { Overview } from '../../../../../components/Overview';
+import { Installation } from '../../../../../components/Installation';
+import { Usage } from '../../../../../components/Usage';
+import { CoreMethods} from '../../../../../components/CoreMethods';
+
+export default function({ asyncapi, params }) {
+  const { info, clientName, title, serverUrl } = BaseInfo(asyncapi, params);
+
+  return (
+    <File name="README.md">
+      <Text newLines={2}>{`# ${title}`}</Text>
+      <Overview info={info} title={title} serverUrl={serverUrl} />
+      <Installation />
+      <Usage clientName={clientName} clientFileName={params.clientFileName} language="python" />
+      <CoreMethods language="python" />
+    </File>
+  );
+}