Guía de recetas en Python
¡Primero que nada, es una excelente noticia que quieras compartir tu conocimiento con la comunidad de desarrolladores!
Hay varias reglas que debes seguir para que tu receta sea publicada. ¡Comencemos!
Estilo
- Asegúrate de que el código sea fácil de leer y entender. Utiliza nombres claros para las variables y funciones.
✅ contact_custom_fields_response
❌ c_cf_resp - Asegúrate de que el fragmento de código resuelva un problema específico o demuestre una funcionalidad particular en Python. Esto podría ser algo útil para la comunidad, como trabajar con APIs o procesamiento de datos.
- Si es posible, evita dependencias externas complejas. Esto facilitará la ejecución del código para los usuarios.
- Si es necesaria una dependencia, proporciona instrucciones de instalación (por ej.: utilizando pip).
- Prueba el código antes de publicarlo. Asegúrate de que funcione correctamente y no contenga errores.
- Sigue las convenciones estándar de formato de código (PEP 8 para Python). Esto mejorará la legibilidad.
- Considera el rendimiento de tu código y evita soluciones que consuman demasiados recursos, a menos que sea necesario.
- Proporciona una posible respuesta a tu código, si es aplicable.
- Proporciona una descripción de cada paso como comentarios antes de la sección de código.
Un ejemplo:
import requests
import csv
#1. Define subdomain y la api_key
#Escribe el subdominio de tu cuenta y el token de acceso o token de larga duración aquí.
SUBDOMAIN = ''
API_KEY = ''
#2. Define template URL
#Pega la URL que utilizarás para cargar los datos.
CREATE_TEMPLATE_URL = f'https://{SUBDOMAIN}.kommo.com/api/v4/chats/templates'
#3. Obtén un archivo CSV
#Obtén un archivo CSV con las plantillas preaprobadas que deseas importar.
with open('templates.csv') as csvData:
templates = csv.DictReader(csvData)
#4. Procesa el archivo CSV
#El documento CSV debe contener dos columnas: 'name' y 'content'.
#El bucle FOR agregará un nombre y el contenido de cada plantilla
#y enviará una solicitud POST para agregar una plantilla con estos datos.
for template in templates:
name = template['name']
body = {
'name' : name,
"content": template['content'],
}
headers = {
'Authorization' : f'Bearer {API_KEY}',
'Content-Type': 'application/json'
}
response = requests.post(CREATE_TEMPLATE_URL, json=body, headers=headers)
print(response.text)
Completa el formulario
Por favor, asegúrate de incluir la siguiente información al enviar tu fragmento de código:
- Título y una breve descripción de la receta, junto con la categoría elegida. Si tu fragmento de código no encaja en las categorías proporcionadas, elige "Otro" y especifica la categoría en las notas.
- Comparte un enlace a tu repositorio de Google Colab o GitHub donde se encuentra almacenado el fragmento de código.
- Proporciona tu nombre de usuario de GitHub/Discord o el nombre de tu compañía si deseas ser acreditado en la descripción de la receta.
- Comparte tu número de teléfono y tu aplicación de mensajería preferida (WhatsApp/Telegram) o tu correo electrónico. Solo nos pondremos en contacto contigo si tenemos preguntas sobre tu fragmento o descripción.
¿Qué sucede a continuación?
Tu formulario será revisado por un moderador y un desarrollador backend dentro de los 10 días posteriores a su envío.
Si tienen preguntas sobre tu código o tus comentarios, recibirás un mensaje en la aplicación de mensajería elegida o un correo electrónico. Por eso te recomendamos proporcionar esa información.
Cuando se publique tu receta, la anunciaremos en nuestro canal de Discord y te etiquetaremos si dejas tu nombre de usuario de Discord.
Si deseas crear una receta en un lenguaje de programación diferente a Python, escríbenos en Discord.
Updated 8 days ago