Forem: Rafnix Guzmán

⚙️ Como automatizar tu librería en PyPI con GitHub Actions

Rafnix Guzmán — Fri, 11 Apr 2025 14:00:56 +0000

Continuando con un post anterior donde publicamos nuestra librera a PyPI, vamos a ir un paso ms all en el proceso de construccin y despliegue (o, mejor dicho, build y release). En este tutorial, crearemos nuestro propio workflow en GitHub Actions , aprovechando que nuestro repositorio ya est en GitHub, para automatizar este proceso y hacerlo ms eficiente y menos propenso a errores.

Al final de este tutorial tendremos configurado un workflow que construye y publica en PyPI de forma automtica con cada nueva release que se cree en el repositorio de GitHub.

👉 Si an no publicaste tu librera en PyPI , te recomiendo comenzar por este tutorial previo:

https://blog.rafnixg.dev/como-publicar-tu-propia-libreria-de-python-guia-paso-a-paso

Qu es GitHub Actions?

GitHub Actions es una plataforma de CI/CD (Integracin y Entrega Continua) integrada directamente en GitHub. Permite automatizar tareas dentro del ciclo de vida de tu proyecto, como ejecutar tests, construir paquetes, y desplegar cdigo, todo sin salir de tu repositorio.

La magia est en los workflows , que son conjuntos de instrucciones definidas en archivos YAML. Estos workflows se ejecutan en respuesta a eventos especficos, como hacer un push, crear un tag, abrir un pull request o crear un nuevo release.

En el caso de una librera de Python, esto nos permite automatizar pasos como:

Construir los paquetes (sdist y wheel)
Publicar automticamente en PyPI o TestPyPI cuando subimos una nueva versin

Con unas pocas lneas de configuracin, podemos lograr que todo esto suceda de forma automtica cada vez que haces un release , reduciendo errores y ganando tiempo.

📦 Automatizando la publicacin en PyPI con GitHub Actions

Requisitos previos

Antes de iniciar, asegrate de tener:

Un repositorio de GitHub con tu librera
Una cuenta de PyPI
Un API Token generado de tu cuenta de PyPI

👉 Si ya seguiste el tutorial anterior, deberas tener todo esto listo. Si no, te recomiendo revisarlo antes de seguir.

🔐 Agregar tu token de PyPI como secret en GitHub

Debemos configurar en nuestro repositorio un nuevo secret para usarlo en los workflows , para esto solo debemos seguir los siguientes pasos:

Ir a tu repositorio en GitHub.
Hacer clic en Settings.
En el men lateral, clic en Secrets and variables Actions.

Clic en New repository secret.
El nombre ser PYPI_API_TOKEN y en el valor peg tu API key de PyPI.
Clic en Add secret.

Esto es lo que usa GitHub Actions para autenticar y publicar la librera.

📁 Estructura de archivos

Ya con todo esto listo podemos empezar, lo primero que debemos saber es que para que nuestra Github Actions funcione los workflows deben estar en una carpeta llama .github/workflows en la raz de nuestro repositorio, dentro de esta carpeta ira nuestro archivo de workflow llamado python-publish.yml.

Podemos crear todo usando los siguientes comandos:

$ mkdir -p .github/workflows$ touch .github/workflows/python-publish.yml

La estructura de archivos quedara similar a esta:

rafnixg-lib/ .github/ workflows/ python-publish.yml src/ rafnixg/ __init__.py __main__.py rafnixg.py LICENSE README.md pyproject.toml

🚀 Configurando el workflow

Vamos a iniciar creando el contenido de nuestro archivo de workflow python-publish.yml.

🎯Activando el workflow al publicar un release

name: Publicar Paquete a PyPIon: release: types: [published]

Esto indica el nombre que tendr nuestro workflow y tambin define que solo se va a ejecutar cuando las release sean published con esto limitamos que solo estas acciones sean las que disparen nuestro workflow.

🛡Definir permisos mnimos necesarios

permissions: contents: read

Ac le decimos a GitHub Actions que este workflow solo necesita leer el contenido del repositorio. Es una buena prctica limitar los permisos al mnimo necesario.

🛠Crear el job y configurar el entorno

jobs: deploy: runs-on: ubuntu-latest

Creamos un job llamado deploy, que se ejecutar en un entorno virtual Ubuntu. Este job va a encargarse de construir y publicar nuestro paquete.

📋Agregar los pasos del workflow

Los steps son partes del proceso que irn ejecutando de forma secuencia y sern lo que ejecutarn los pasos para publicar nuestra librera en PyPI luego de ser construida.

En los steps se puede hacer uso de otros actions creados por otros usuarios como si de libreras se tratase, solo debemos indicarlo con uses: actions/nombre-del-actions@version y tambien podemos usar comando sobre la mquina virtual donde se est ejecutando la actions con el comando run: comando bash

steps: - name: Clonando repositorio uses: actions/checkout@v3 - name: Configurando Python 3 uses: actions/setup-python@v3 with: python-version: '3.x' - name: Instalando dependencias run: | python -m pip install --upgrade pip pip install build - name: Construir Paquete run: python -m build - name: Publicar Paquete uses: pypa/gh-action-pypi-publish@release/v1 with: user: __token__ password: ${{ secrets.PYPI_API_TOKEN }}

📂 Clonando el repositorio

- name: Clonando repositorio uses: actions/checkout@v3

Usamos la accin oficial para clonar el cdigo del repositorio , paso necesario para poder construir el paquete.

🐍 Configurar el entorno de Python

- name: Configurando Python 3 uses: actions/setup-python@v3 with: python-version: '3.x'

Le decimos a GitHub Actions que configure un entorno de Python (versin 3.x). Esto es clave para poder instalar dependencias y ejecutar los comandos de build.

📥 Instalando las dependencias necesarias

- name: Instalando dependencias run: | python -m pip install --upgrade pip pip install build

Actualizamos pip y luego instalamos el mdulo build, que nos permite crear los archivos .tar.gz y .whl que necesita PyPI.

🏗Construir el paquete

- name: Construir Paquete run: python -m build

Este paso ejecuta python -m build, que genera el paquete listo para ser publicado en la carpeta dist/.

📤Publicar el paquete en PyPI

- name: Publicar Paquete uses: pypa/gh-action-pypi-publish@release/v1 with: user: __token__ password: ${{ secrets.PYPI_API_TOKEN }}

Finalmente, usamos la accin oficial para subir el paquete a PyPI. Aqu usamos el API Key que se guarda como Secret en el repositorio de GitHub (PYPI_API_TOKEN), para evitar exponer credenciales.

📄 Archivo completo del workflow (`python-publish.yml`)

El archivo python-publish.yml finalmente queda de la siguiente manera:

name: Publicar Paquete a PyPIon: release: types: [published]jobs: deploy: runs-on: ubuntu-latest steps: - name: Clonando repositorio uses: actions/checkout@v3 - name: Configurando Python 3 uses: actions/setup-python@v3 with: python-version: '3.x' - name: Instalando dependencias run: | python -m pip install --upgrade pip pip install build - name: Construir Paquete run: python -m build - name: Publicar Paquete uses: pypa/gh-action-pypi-publish@release/v1 with: user: __token__ password: ${{ secrets.PYPI_API_TOKEN }}

💾 Subiendo los cambios al repositorio

Ya con nuestro archivo creado, solo nos resta subir un commit con los cambios que tenemos:

$ git add .github/workflows/python-publish.yml$ git commit -m "Add GitHub Actions workflow for PyPI release"$ git push origin

Creamos un tag y lo subimos:

$ git tag v1.0.1$ git push origin --tags

Revisamos nuestro repositorio de GitHub y nos aseguramos de que se subi todo correctamente, para seguir con la creacin de una nueva release.

🏷 Crear una nueva release en GitHub

En nuestro repositorio hacemos clic en Releases. para ingresar a la pgina de todas las releases que vamos a haciendo.

En esta pgina hacemos clic en draf a new release

Esto nos abre el formulario para crear nuevas releases, ac debemos seleccionar el tag correspondiente con la release en Choose a tag y hacer clic en Generate release notes, esto genera una descripcin usando los commits y los Pull Request.

Por ltimo, revisa la descripcin ajusta si lo necesitas y dale clic a Publish release.

Verificar el resultado de la publicacin

Cada vez que crees una nueva release , se publicar una nueva versin de tu paquete en PyPI. En la tab Actions de nuestro repositorio vamos a ver cmo se ejecuta el workflow que lo publica.

🧠 Conclusin

Automatizar la publicacin con GitHub Actions no solo te ahorra tiempo, tambin reduce errores y hace que todo el proceso sea mucho ms limpio y profesional. Una vez configurado, solo tienes que enfocarte en mejorar tu librera y dejar que la publicacin se maneje sola

🔍Referencias

🏗️ Cómo publicar tu propia librería de Python: Guía paso a paso

Rafnix Guzmán — Fri, 04 Apr 2025 20:43:39 +0000

El objetivo de este tutorial es guiarte paso a paso en el proceso de creacin y publicacin de tu propia librera en Python. Aunque Python ofrece una biblioteca estndar muy completa, aprovechar las contribuciones de la comunidad en PyPI te permite extender sus capacidades y crear soluciones personalizadas que se adapten a tus necesidades.

La motivacin detrs de este proyecto es doble: por un lado, adquirir un conocimiento profundo sobre el proceso de preparacin, versionado, construccin y despliegue de paquetes; y por el otro, consolidar un repositorio centralizado de herramientas que funcione como una tarjeta de presentacin profesional en el mundo del desarrollo.

https://github.com/rafnixg/rafnixg-lib

🧭 Introduccin y primeros pasos

El primer paso es comprender el ecosistema de paquetes en Python, especialmente el rol fundamental que juega PyPI (Python Packaging Index). Este es el repositorio oficial de paquetes de Python, y alberga una vasta coleccin de libreras, desde implementaciones simples hasta complejas soluciones en reas como ciencia de datos, inteligencia artificial y desarrollo web.

Al entender cmo se organizan y distribuyen los paquetes en PyPI, puedes orientar el desarrollo de tu librera para que cumpla con los estndares que facilitan su instalacin y uso por parte de otros desarrolladores. Adems, al prepararla para su publicacin, te adentras en prcticas modernas como el versionado semntico y la automatizacin del despliegue.

Nuestro inicio en el mundo de las libreras lo vamos a tener en la prxima seccin donde ya iniciaremos el cdigo fuente que usaremos como base para todo el proceso de tener nuestra propia librera en PyPI.

https://pypi.org/project/rafnixg/

🏗 Crear la base de tu librera en Python

En esta seccin crearemos el cdigo base que usaremos para subir a PyPI, t puedes usar este cdigo como ejemplo o ser libre de usar el cdigo de tu preferencia, y saltar a la siguiente seccin.

Si te quedaste ac el paquete que vamos a crear se llama rafnixg y muestra por consola tus datos personales y por otro lado podr ser usado en tu propio cdigo para descargar post de tu blog de HashNode usando GraphQL. Este es bsicamente mi caso de uso de ejemplo, pero tu librera puede tener las funciones que tu consideres necesarias.

Para lograr obtener este diseo de card vamos a hacer uso de la librera rich que nos ayuda a crear diseos de tablas para la terminal de forma fcil, los invito a revisar el potencial de rich, puede agregar iconos, gestionar paleta de colores, Markdown.

https://pypi.org/project/rich/

🧪Preparacin del entorno de desarrollo

Para este caso hare uso de VSCode pero puedes usar el editor que prefieras, ac lo importante es crear un entorno virtual de Python para aislar las dependencias y no tener problemas en el futuro.

$ python -m venv env$ source env/bin/activate # Para Linux$ env\Scripts\activate # Para Windows(env) $ pip install rich

Lo segundo ser crear un archivo .gitignore que nos ayudar a indicar que no queremos que se suba a nuestro repositorio, podemos hacer uso de la siguiente web para generar uno con la configuracin para Python.

Create Useful .gitignore Files For Your Project

# Created by https://www.toptal.com/developers/gitignore/api/python# Edit at https://www.toptal.com/developers/gitignore?templates=python### Python #### Byte-compiled / optimized / DLL files __pycache__ /*.py[cod]*$py.classenv.env/venvvenv# End of https://www.toptal.com/developers/gitignore/api/python

Debemos recordar que es importante evitar subir archivos con contenido sensibles como API Keys, Claves o algn tipo de informacin que permita acceso no autorizado.

Luego de esto inicializamos nuestro repositorio de git y creamos nuestra estructura de archivos.

(env) $ git init

📁 Estructura del proyecto

Toda librera de Python inicia dentro de una carpeta, as que para esto cree el directorio rafnixg-lib y dentro creo la siguiente estructura de archivos:

rafnixg-lib/ src/ rafnixg/ __init__.py __main__.py rafnixg.py LICENSE README.md pyproject.toml

Todo el cdigo fuente se encuentra de src/ esto no es obligatorio, pero es una buena prctica. Si estas usando tu propio cdigo, dentro de src/ es donde debera ir para mantener la mejor estructura.

En esta seccin nos enfocaremos en los archivos de Python y en las siguientes secciones veremos estos archivos especiales LICENSE, README.md, pyproject.toml.

🧾 Crear el archivo principal src/rafnixg/rafnixg.py

"""src/rafnixg/rafnixg.pyRafnixG - Personal Card"""from rich.console import Consolefrom rich.table import Tableclass RafnixG: """RafnixG - Personal Card""" def __init__ (self): self.username = "rafnixg" self.name = "Rafnix Guzmn" self.position = "Python Software Developer" self.links = "https://links.rafnixg.dev" self.web = "https://rafnixg.dev" self.blog = "https://blog.rafnixg.dev" self.cv = "https://resume.rafnixg.dev" self.github = "https://github.com/rafnixg" self.twitter = "@rafnixg" self.about = "Experienced software developer with 10+ years of expertise in designing, developing and implementing web systems across various sectors. Backend specialist skilled in Python, Linux, and Git. Passionate about continuous learning and open-source technology." def __str__ (self): return f"{self.name} (@{self.username}) - {self.position}" def display(self): """Display personal card""" # Crea un objeto Console para imprimir en la consola console = Console() table = Table( show_header=False, # No mostrar encabezados title=str(self), # Ttulo de la tabla highlight=True, # Resaltar la tabla title_style="bold magenta", # Estilo del ttulo ) # Agrega columnas a la tabla table.add_column("Attribute", style="bold", width=16) table.add_column("Value") # Agrega filas a la tabla con los atributos y valores de la clase # Itera sobre los atributos de la clase y los agrega a la tabla for key, value in self. __dict__.items(): if isinstance(value, dict): for sub_key, sub_value in value.items(): table.add_row(sub_key, ", ".join(sub_value)) elif isinstance(value, list): table.add_row(key, ", ".join(value)) else: table.add_row(key, value) # Imprime la tabla en la consola console.print(table)

🧩 Inicializar el paquete con src/rafnixg/init.py

"""src/rafnixg/ __init__.pyRafnixG - Personal Card"""from rafnixg.rafnixg import RafnixG __version__ = "1.0.0"

🧩 Ejecutar como modulo con src/rafnixg/main.py

"""src/rafnixg/ __main__.pyRafnixG - Personal Card"""from rafnixg import RafnixGdef main(): """Main function.""" me = RafnixG() me.display()if __name__ == ' __main__': main()

🖥 Ejecutar y probar tu cdigo localmente

Para probar nuestro cdigo debemos movernos a la carpeta src/ y luego correr el paquete como un mdulo de Python:

(env) $ cd src(env) $ ls rafnixg/(env) $ python -m rafnixg

Recuerda que si estas usando tu cdigo aqu debes colocar el nombre la carpeta que contiene tu cdigo fuente.

📦 Preparar la librera para ser publicada

📘Documentando nuestra librera

Un README es esencial para cualquier proyecto ya que aqu es donde otros desarrolladores y usuarios obtendrn informacin sobre tu librera, en este archivo no solo se explica que es y lo que hace tu proyecto, sino que tambin contiene informacin de como instalarlo, utilizarlo y contribuir. En una prxima publicacin profundizaremos ms sobre el README y que debera contener, por los momentos creamos el archivo README.md con el siguiente contenido:

# Rafnix Guzmn - Personal Card (README.md)## Hi there 👋This is my personal card [rafnixg.dev](https://rafnixg.dev)![image](https://github.com/user-attachments/assets/4c1c368b-83ca-4ff7-89d0-c131efe60c9f)## How to use it? 🤔Install using pip:```

bashpip install rafnixg

```Then run it:```

bashrafnixg




### 🛠Configurar el sistema de construccin (build system)

Para preparar nuestra librera para ser publicada en **_PyPI_** necesitamos configurar algunas secciones en el archivo `pyproject.toml` primero debemos indicar el **build system** que es la parte responsable de crear los archivos que se suben a PyPI, usualmente se usa el formato **wheel** o **sdist**.

Nosotros usaremos el [setuptools](https://setuptools.pypa.io/) como **build system.**



```toml
# pyproject.toml[build-system]requires = ["setuptools>=61.0.0", "wheel"]build-backend = "setuptools.build_meta"

🗂 Organizar el archivo `pyproject.toml`

Ahora agregaremos una seccin para configurar informacin del proyecto, ac es donde indicaremos el nombre de nuestro paquete, recordemos que debemos verificar que el nombre no este usado por ningn otro paquete dentro del ecosistema PyPI.

# pyproject.toml...[project]name = "rafnixg"version = "1.0.0"description = "Rafnix Guzman Personal Card"readme = "README.md"authors = [{ name = "Rafnix Guzman", email = "rafnixg@gmail.com" }]license = { file = "LICENSE" }classifiers = ["License :: OSI Approved :: MIT License", "Programming Language :: Python", "Programming Language :: Python :: 3",]keywords = ["personal card", "console"]dependencies = ["rich",]requires-python = ">=3.9"[project.optional-dependencies]dev = ["black", "bumpver", "isort", "pip-tools", "pytest"][project.urls]Homepage = "https://github.com/rafnixg/rafnixg-lib"[project.scripts]rafnixg = "rafnixg. __main__ :main"

No toda esta informacin es obligatoria, pero es importante dar la mayor cantidad de informacin posible sobre nuestra librera, la informacin mnima que podemos ingresar es name y version .

Las siguientes secciones son importantes por la informacin que le proporcionan a PyPI:

classifiers: Lista de classifiers de PyPI que ayudan a la bsqueda.
keywords: Lista de etiquetas que seran usadas para identicar y categorizar la libreria.
dependencies: Lista de dependencias que tu librera necesita, en nuestro caso rich.
project.optional-dependencies: Lista de las dependencias de desarrollo.
project.urls: Links que relacione a tu proyecto en github o alguna pgina web.
project.scripts: Punto de entrada para tu librera. en este caso el comando ser rafnixg y el punto de entrada ser rafnixg. __main__ :main

Toda esta informacin hace que en PyPI tu librera se vea mucho mejor y cuando se haga una bsqueda tambin sea ms fcil de encontrar. ac un ejemplo de la informacin que se muestra en PyPI :

Vemos como tambin usa el archivo README.md para mostrar del lado derecho la documentacin de la librera en PyPI , y los datos del archivo pyproject.toml tambin se muestran a la izquierda.

Para saber ms sobre este archivo de configuracin ac esta la documentacin.

🔢 Usar versionamiento semntico

Toda librera debe tener un versionamiento para poder tener un control de lo que se publica, existen diferentes esquemas de versionamiento, en nuestro caso usaremos Semantic Versioning que es una forma simple de gestionar el versionamiento formado por 3 grupo de nmeros, ejemplo: MAJOR.MINOR.PATCH las recomendaciones para cambiar estos nmeros son:

MAJOR : Cuando tus cambios son tan grandes que rompen tu API anterior.
MINOR : Cuando agregas nuevas funciones y todo se mantiene compatible, Vuelve a 0 cuando MAJOR cambia.
PATCH : Cuando agregas bug fixes, vuelve a 0 cuando MINOR cambia.

Para gestionar esto en Python haremos uso de una librera llamada bumpver esto modifica directamente los archivos y as mantiene sincronizado en todos lados la versin.

(venv) $ python -m pip install bumpver(venv) $ bumpver initWARNING - Couldn't parse pyproject.toml: Missing version_patternUpdated pyproject.toml

Este comando inicializa en pyproject.toml la gestin de las versiones, si vemos agrego una nueva seccin:

[tool.bumpver]current_version = "1.0.0"version_pattern = "MAJOR.MINOR.PATCH"commit_message = "bump version {old_version} -> {new_version}"commit = truetag = truepush = false[tool.bumpver.file_patterns]"pyproject.toml" = ['current_version = "{version}"', 'version = "{version}"']"src/rafnixg/ __init__.py" = ["{version}"]

Si no se parece a esta ajustar el version_pattern para que sean iguales, despus de configurar esto, t puedes cambiar la versin usando los comandos de bumpver:

(venv) $ bumpver update --minorINFO - Old Version: 1.0.0INFO - New Version: 1.1.0INFO - git commit --message 'bump version 1.0.0 -> 1.1.0'INFO - git tag --annotate 1.1.0 --message '1.1.0'

📜 Elegir una licencia adecuada

Cuando creamos una librera debemos elegir que permisos queremos que los dems tengan sobre nuestro cdigo, as se podr saber qu es lo que quiere que se haga o no con tu librera. Una licencia muy usada para compartir cdigo es la Licencia MIT con esta licencia simple y bastante permisiva.

Lo que debemos hacer es crear un archivo de texto llamado LICENSE que contenga el texto de nuestra licencia, si no sabes que licencia escoger existe esta web que permite ver cul es la ms conveniente segn tus necesidades: Choose an open source license

📥 Instalar tu librera localmente

Para este punto ya tenemos nuestra librera lista para ser publicada, ahora lo que vamos a necesitar hacer es probar nuestra librera instalndola directamente en nuestro entorno virtual, para esto haremos uso de los siguientes comandos:

(env) $ python -m pip install -e .

Con el flag -e se instala tu librera en modo editable y con . indicamos donde se encuentra el archivo pyproject.toml esto ya deja disponible nuestro comando rafnixg que est definido en la seccin project.scripts indicando el punto de entrada.

(env) $ rafnixg Rafnix Guzmn Garcia (@rafnixg) - Python Software Developer username rafnixg name Rafnix Guzmn Garcia position Python Software Developer links https://links.rafnixg.dev web https://rafnixg.dev blog https://blog.rafnixg.dev cv https://resume.rafnixg.dev github https://github.com/rafnixg twitter @rafnixg about Experienced software developer with 10+ years of expertise in designing, developing and implementing web systems across various sectors. Backend specialist skilled in Python, Linux, and Git. Passionate about continuous learning and open-source technology.

🚀 Publica tu librera a PyPI

Ya nuestra librera se encuentra lista y a la espera de conocer el mundo, en esta seccin haremos el empaquetado y despliegue a PyPI.

🧑💻 Crear cuentas en PyPI y TestPyPI

Lo primero que debemos tener es una cuenta en PyPI , as que si no la tienes este es tu momento de registrarte: https://pypi.org/account/register/

Tambin deberamos crear una cuenta en el ambiente de pruebas de PyPI , as siempre podemos verificar que todo va bien antes de lanzar algo a produccin: https://test.pypi.org/account/register/

Recuerden crear sus API Key porque en el proceso de publicacin mas adelante sern necesarias.

🔐 Generar una API Key

Para esto ingresamos a Configuracion de la cuenta bajamos y buscamos la opcin Fichas de API , hacemos clic en el botn Aadir ficha de API

Luego le ponen algn nombre descriptivo a esta Key , seleccionamos el Alcance y por ltimo clic al botn Create Token

Con esto nos mostrara nuestra API Key que siempre empieza por pypy- como se muestra en la imagen de abajo:

Hacemos clic en Copiar Ficha y guardamos nuestra API Key en algn lugar seguro**.** Siempre van a tener la posibilidad de borrar la key y generar otra si es necesario la pierden.

🚩

Nunca debemos compartir la API Key o agregarla directamente a un archivo que pueda estar trackeado en GIT.

Luego de todo esto debemos instalar 2 libreras que nos ayudaran a construir y publicar nuestro paquete:

(env) $ python -m pip install build twine

🛠 Construir el paquete con `build`

Ahora que tenemos nuestra librera lista, ya podemos hacer la distribucin del cdigo a PyPI , para esto primero debemos empaquetar nuestra librera en formato wheels , un formato que consiste en empaquetar en un archivo tar todo el cdigo fuente de la librera. Para crear este archivo haremos uso de la librera build:

(env) $ python -m build[...]Successfully built rafnixg-1.0.0.tar.gz and rafnixg-1.0.0-py3-none-any.whl

Esto nos crea una nueva carpeta llamada dist/ que contiene el archivo .tar.gz con el cdigo de nuestra librera y el archivo .whl que es nuestro archivo wheels , esto es todo lo que necesitamos para subir a PyPI.

Verificar el paquete con `twine check`

Para validar que todo fue empaquetado correctamente podemos usar twine:

(env) $ twine check dist/*Checking dist/rafnixg-1.0.0-py3-none-any.whl: PASSEDChecking dist/rafnixg-1.0.0.tar.gz: PASSED

Subir el paquete a PyPI

Ahora que tenemos todo listo y verificado, podemos subir a TestPyPI para ver que todo va con normalidad y no tenemos ningn error en nuestra librera:

(env) $ twine upload -r testpypi dist/*

Nos pedir nuestra API Key. Ya con esto podemos probar nuestra librera usando el siguiente comando:

(env) $ pip install -i https://test.pypi.org/simple/ rafnixg

Si todo sali con normalidad, podemos subir a l repositorio principal de PyPI :

(env) $ twine upload dist/*

Con esto tendramos nuestro proyecto ya disponible para usar con pip, podemos a PyPI y buscar nuestra librera.

https://pypi.org/project/rafnixg

📥 Instalar tu paquete desde PyPI

Ya con nuestra librera publicada en PyPI podemos usarla con el siguiente comando:

(env) $ python -m pip install rafnixg(env) $ rafnixg

🧠 Conclusiones

Crear y publicar tu propio paquete en Python es una experiencia enriquecedora que va ms all de compartir cdigo: es una oportunidad para aprender sobre la estructuracin de proyectos, el versionado semntico y las buenas prcticas de la comunidad. A lo largo de este tutorial, hemos recorrido desde la configuracin del entorno de desarrollo hasta la publicacin en PyPI , enfatizando la importancia de una documentacin clara y una estructura ordenada. Con estos conocimientos, no solo mejoras tus habilidades tcnicas, sino que tambin das un paso significativo hacia la consolidacin de tu perfil profesional en el mundo del desarrollo. Atrvete a experimentar, optimizar tu paquete y contribuir al ecosistema open source!

📰

En una prxima publicacin veremos cmo podemos crear un flujo de CI/CD con Github Actions para automatizar la publicacin de nuestra librera, tambin como documentarla y publicar con Github Pages esta documentacin. Cualquier duda o consulta djalo en la seccin de comentarios.

]]>

Shell de Odoo: Domina Operaciones Avanzadas, Integración de Librerías y Automatización de Tareas

Rafnix Guzmán — Mon, 10 Apr 2023 21:24:39 +0000

En un post anterior, exploramos los conceptos bsicos de la shell de la CLI de Odoo y cmo configurar IPython como REPL para mejorar nuestra experiencia de desarrollo. Ahora, profundizaremos en el uso de la shell de Odoo, abordando temas ms avanzados y descubriendo cmo sacarle el mximo provecho a esta poderosa herramienta.

El propsito de este post es proporcionar una gua completa para los desarrolladores de Odoo que deseen llevar sus habilidades al siguiente nivel y dominar el uso de la shell en sus proyectos. A lo largo del artculo, cubriremos temas como acceso avanzado, operaciones avanzadas, integracin de libreras externas, automatizacin de tareas y seguridad en la shell de Odoo.

Acceso avanzado a la shell de Odoo

La shell de Odoo es una herramienta poderosa que nos permite interactuar con el sistema Odoo y ejecutar tareas de desarrollo y administracin. En esta seccin, profundizaremos en algunas tcnicas avanzadas para acceder y utilizar la shell de Odoo de manera ms efectiva.

Uso de diferentes archivos de configuracin

En ocasiones, puede ser til tener diferentes archivos de configuracin para distintos entornos o propsitos. Por ejemplo, podras querer tener un archivo de configuracin especfico para trabajar con la shell de Odoo, que incluya parmetros ajustados para este propsito, como el nmero de workers, los lmites de memoria y los puertos XML-RPC y Longpolling.

Para utilizar un archivo de configuracin especfico al acceder a la shell de Odoo, simplemente especifica la ruta del archivo con el parmetro -c al ejecutar el comando odoo-bin shell. Por ejemplo:

./odoo-bin shell -c /path/to/your/custom/odoo.conf

Asegrate de que tu archivo de configuracin personalizado incluye todos los parmetros necesarios para que la shell de Odoo funcione correctamente.

Acceso remoto a la shell de Odoo

En algunos casos, es posible que desees acceder a la shell de Odoo en un servidor remoto, en lugar de ejecutarla localmente. Para hacer esto, puedes utilizar una herramienta como ssh para establecer una conexin segura con el servidor remoto y acceder a la shell de Odoo desde all.

Primero, asegrate de tener ssh instalado en tu mquina local y que tienes acceso al servidor remoto con las credenciales adecuadas. Luego, ejecuta el siguiente comando para establecer una conexin ssh con el servidor remoto:

ssh user@remote-server-ip

Una vez que hayas iniciado sesin en el servidor remoto, navega hasta el directorio de instalacin de Odoo y sigue los pasos habituales para acceder a la shell de Odoo utilizando el comando odoo-bin shell y el archivo de configuracin deseado.

Al utilizar el acceso remoto a la shell de Odoo, ten en cuenta las implicaciones de seguridad y sigue las mejores prcticas para proteger tus datos y evitar accesos no autorizados.

Operaciones avanzadas en la shell de Odoo

La shell de Odoo ofrece muchas posibilidades para realizar tareas de desarrollo y administracin de manera eficiente. En esta seccin, abordaremos algunas operaciones avanzadas que puedes realizar en la shell de Odoo, lo que te permitir aprovechar an ms esta herramienta.

Actualizacin de mdulos desde la shell

Es posible actualizar mdulos directamente desde la shell de Odoo. Para actualizar un mdulo existente, utiliza el mtodo button_upgrade() en el mdulo que deseas actualizar:

module = env['ir.module.module'].search([('name', '=', 'my_module')])
module.button_upgrade()

Donde 'my_module' es el nombre del modulo que deseo actualizar.

Importacin y exportacin de datos en formatos CSV

La shell de Odoo tambin facilita la importacin y exportacin de datos en formatos CSV y XML. Para importar datos desde un archivo CSV, sigue estos pasos:

Instala la librera csv en tu entorno de Odoo.
Utiliza la siguiente estructura para leer y procesar el archivo CSV:

import csv

with open('data.csv', 'r') as csvfile:
    reader = csv.DictReader(csvfile)
    for row in reader:
        # Procesa cada fila del archivo CSV

Para exportar datos a un archivo CSV, puedes utilizar un enfoque similar:

import csv

with open('data.csv', 'w') as csvfile:
    fieldnames = ['field1', 'field2', 'field3']
    writer = csv.DictWriter(csvfile, fieldnames=fieldnames)

    writer.writeheader()
    for record in records:
        # Escribe cada registro en el archivo CSV

Para trabajar con datos en formato XML, puedes utilizar libreras como lxml o xml.etree.ElementTree.

Trabajo con registros y campos relacionales

La shell de Odoo facilita el trabajo con registros y campos relacionales. Para acceder a un campo relacional (por ejemplo, un campo Many2one), simplemente utiliza la notacin de punto:

record = env['res.partner'].browse(1)
print(record.parent_id)
print(record.company_id.name)

Para acceder a campos relacionales inversos (por ejemplo, campos One2many o Many2many), utiliza la misma notacin de punto:

record = env['res.partner'].browse(1)
print(record.child_ids)
for child in record.child_ids:
    print(child.id)

Bsqueda y manipulacin de registros con filtros y operadores avanzados

La shell de Odoo te permite buscar y manipular registros utilizando filtros y operadores avanzados usando la notacion de domains de Odoo. Por ejemplo, puedes utilizar el operador like para buscar registros que coincidan con un patrn especfico:

records = env['res.partner'].search([('name', 'like', 'R%')])

Tambin puedes combinar mltiples criterios de bsqueda utilizando operadores lgicos como & (AND) y | (OR):

records = env['res.partner'].search(['&', ('name', 'like', 'R%'), ('country_id.code', '=', 'PE')])

Uso de contextos

Los contextos en Odoo son una herramienta til para personalizar el comportamiento de las operaciones en funcin de ciertos parmetros, como el idioma o el usuario. Puedes utilizar contextos para realizar consultas en diferentes idiomas o para aplicar filtros especficos a nivel de usuario.

Por ejemplo, para buscar registros en un idioma especfico, puedes pasar el cdigo de idioma en el contexto:

records = env['res.partner'].with_context(lang='es_ES').search([])

Esto retornar los registros traducidos al idioma especificado en el contexto (en este caso, espaol).

Tambin puedes utilizar contextos para aplicar filtros especficos a nivel de usuario. Por ejemplo, si deseas buscar registros que solo sean visibles para un usuario especfico, puedes hacer lo siguiente:

user_id = 2 # ID del usuario especfico
user = env['res.users'].browse(user_id)
records = env['res.partner'].with_context(user=user).search([])

Esto retornar los registros de socios comerciales que solo son visibles para el usuario con ID 2.

Integracin de libreras externas en la shell de Odoo

La shell de Odoo es un entorno interactivo de Python, lo que significa que puedes importar y utilizar libreras externas de Python para mejorar y ampliar la funcionalidad de la shell. En esta seccin, exploraremos cmo utilizar algunas libreras tiles para el anlisis y tratamiento de datos y tambin mencionaremos otras libreras que podran resultar de inters.

Uso de Pandas para el anlisis y tratamiento de datos

Pandas es una biblioteca de Python popular y poderosa que ofrece estructuras de datos y herramientas de anlisis de datos. Su integracin en la shell de Odoo puede ser til para realizar anlisis de datos y para trabajar con grandes conjuntos de registros.

Para utilizar Pandas en la shell de Odoo, primero debes instalarla en tu entorno de Python:

pip install pandas

Una vez instalada, puedes importar Pandas en la shell de Odoo y empezar a utilizar sus funciones. Por ejemplo, puedes utilizar la funcin DataFrame de Pandas para convertir un conjunto de registros de Odoo en un DataFrame de Pandas:

import pandas as pd

partners = env['res.partner'].search([])
data = []

for partner in partners:
    data.append({
        'id': partner.id,
        'name': partner.name,
        'email': partner.email,
        'country': partner.country_id.name,
    })

df = pd.DataFrame(data)

Ahora que tienes un DataFrame de Pandas, puedes utilizar todas las funciones y herramientas de anlisis de datos que ofrece Pandas. Por ejemplo, puedes realizar agrupaciones, filtrados, ordenamientos y mucho ms.

Otras libreras tiles para mejorar el trabajo en la shell

Adems de Pandas, hay muchas otras libreras de Python que pueden ser tiles en la shell de Odoo. A continuacin, se mencionan algunas de ellas:

NumPy : Esta biblioteca es muy til para realizar clculos matemticos y estadsticos en conjuntos de datos. Puedes utilizar NumPy junto con Pandas para llevar a cabo anlisis avanzados en tus datos de Odoo.
Requests : Requests es una biblioteca popular para realizar solicitudes HTTP en Python. Puedes utilizarla en la shell de Odoo para interactuar con servicios web y APIs externas.
OpenPyXL : OpenPyXL es una biblioteca de Python para leer y escribir archivos Excel. Puedes utilizarla en la shell de Odoo para importar y exportar datos en formato Excel.

Estas son solo algunas de las muchas libreras disponibles para Python que pueden mejorar tu experiencia de trabajo en la shell de Odoo. No dudes en explorar otras libreras y adaptarlas a tus necesidades especficas.

Automatizacin de tareas con la shell de Odoo

Una de las ventajas de trabajar con la shell de Odoo es la posibilidad de automatizar tareas y procesos. En esta seccin, exploraremos cmo ejecutar scripts y comandos desde archivos externos y cmo programar tareas automatizadas y cron jobs desde la shell.

Ejecucin de scripts y comandos desde archivos externos

En lugar de ejecutar comandos individualmente en la shell de Odoo, puedes crear un archivo de script de Python que contenga una serie de comandos y ejecutar ese archivo. Esto facilita la automatizacin y la reutilizacin de cdigo.

Para ejecutar un script de Python usando el entorno de Odoo, debemos crear primero un script wrapper que nos permita ejecutar nuestros scripts inyectando el entorno de odoo. sigue estos pasos:

Crea un archivo llamado odoo_wrapper.py con el siguiente contenido:
Crea un archivo de script de Python (por ejemplo, mi_script.py) con una funcin llamada run que reciba un argumento env:

def run(env):
    # Tus comandos aqui, utilizando la variable 'env' para acceder a la API de Odoo
    # Este archivo puede ser todo lo complejo que tu quieras
    # Para probar usemos esto de ejemplo:
    partners = env['res.partner'].search([])
    print("Numero de contactos:", len(partners))

Desde la lnea de comandos, navega hasta el directorio donde se encuentra el archivo odoo_wrapper.py.
Ejecuta el siguiente comando para ejecutar el archivo odoo_wrapper.py y que a su vez ejecute tu archivo mi_script.py:

python3 odoo_wrapper.py /path/to/mi_script.py

El archivo odoo_wrapper.py se encargar de ejecutar el archivo mi_script.py utilizando la API de Odoo y la base de datos especificada en el archivo de configuracin. La funcin run en tu archivo mi_script.py se ejecutar con el entorno de Odoo proporcionado.

Programacin de tareas automatizadas y cron jobs desde la shell

La shell de Odoo tambin te permite programar tareas automatizadas y cron jobs directamente desde la shell. Estas tareas se ejecutarn en intervalos especficos y pueden ser tiles para automatizar procesos como copias de seguridad, actualizaciones, sincronizaciones y ms.

Para programar una tarea automatizada o un cron job desde la shell de Odoo, sigue estos pasos:

En la shell de Odoo, accede al modelo ir.cron:
Crea un nuevo registro de cron job utilizando el mtodo create() y proporciona los detalles necesarios, como el nombre, el modelo, el mtodo y el intervalo de tiempo:

ir_cron.create({
    'name': 'Mi Cron Job',
    'model_id': env.ref('base.model_res_partner').id,
    'state': 'code',
    'code': "model.my_custom_method()",
    'interval_number': 1,
    'interval_type': 'days',
    'numbercall': -1,
    'doall': False,
    'active': True,
})

En este ejemplo, hemos creado un cron job que ejecutar el mtodo my_custom_method() en el modelo res.partner cada da. Puedes personalizar los parmetros segn tus necesidades.

Una vez creada la tarea, se ejecutar automticamente segn el intervalo de tiempo especificado. Puedes verificar y administrar las tareas automatizadas y los cron jobs en la interfaz web de Odoo, bajo Configuracin > Tcnico > Automatizacin > Tareas programadas.

Seguridad y buenas prcticas en el uso de la shell de Odoo

Recomendaciones para proteger la informacin y evitar accesos no autorizados

Cuando trabajamos con la shell de Odoo, es importante tener en cuenta la seguridad y garantizar que la informacin y los datos estn protegidos. A continuacin, se presentan algunas recomendaciones para proteger la informacin y evitar accesos no autorizados:

Controlar el acceso a la shell de Odoo : Limita el acceso a la shell de Odoo a los usuarios que realmente necesitan usarla. Asegrate de que las credenciales de inicio de sesin y los permisos estn configurados correctamente para restringir el acceso solo a los usuarios autorizados.
Proteger el archivo de configuracin : El archivo de configuracin de Odoo puede contener informacin sensible, como contraseas de base de datos y otros datos de configuracin. Asegrate de proteger este archivo mediante permisos de lectura y escritura adecuados y almacenarlo en una ubicacin segura.
Hacer copias de seguridad de los datos : Realiza copias de seguridad peridicas de la base de datos de Odoo y almacena estas copias de seguridad en un lugar seguro y protegido. Esto te permitir restaurar los datos en caso de un problema de seguridad o una prdida de datos accidental.

Uso responsable de la shell en entornos de produccin

Es importante utilizar la shell de Odoo de manera responsable en entornos de produccin para evitar problemas y garantizar la estabilidad del sistema. Aqu hay algunas pautas para usar la shell de Odoo de manera responsable:

Evitar cambios en tiempo real en entornos de produccin : Aunque la shell de Odoo permite realizar cambios en tiempo real en la base de datos y el sistema, estos cambios pueden tener consecuencias imprevistas. Siempre es mejor realizar cambios en un entorno de desarrollo o prueba antes de aplicarlos en un entorno de produccin.
Limitar el uso de la shell en entornos de produccin : Utiliza la shell de Odoo en entornos de produccin solo cuando sea necesario y por el tiempo estrictamente necesario. Evita dejar sesiones de shell abiertas innecesariamente.
Registrar y auditar el uso de la shell : Mantn un registro de quin accede a la shell de Odoo y qu acciones se realizan en la shell. Estos registros pueden ser tiles para identificar problemas de seguridad y realizar auditoras.
Seguir las mejores prcticas de desarrollo : Al utilizar la shell de Odoo para desarrollar mdulos y realizar cambios en la plataforma, sigue las mejores prcticas de desarrollo de Odoo para garantizar un cdigo seguro, eficiente y fcil de mantener.

Conclusin

En este artculo, se profundizado en el uso y la configuracin de la shell de Odoo para aprovechar su potencial y mejorar nuestras habilidades en el desarrollo y la gestin de Odoo. Hemos cubierto temas esenciales como el acceso avanzado a la shell, la realizacin de operaciones avanzadas, la integracin de libreras externas, la automatizacin de tareas y la implementacin de medidas de seguridad y buenas prcticas.

Espero que este artculo te haya proporcionado una comprensin ms profunda del potencial de la shell de Odoo y te haya equipado con el conocimiento necesario para aprovechar sus capacidades en tus proyectos. Te invitos a aplicar y experimentar con lo aprendido, y a compartir tus experiencias y conocimientos con otros miembros de la comunidad Odoo.

Explorando Odoo a fondo: Cómo trabajar con la shell de la CLI y configurar IPython como REPL

Rafnix Guzmán — Thu, 30 Mar 2023 12:00:39 +0000

Hola a todos! Hoy vamos a explorar un tema esencial para todos los programadores de Odoo que deseen profundizar en el desarrollo y uso del ORM de Odoo: la shell de la CLI de Odoo. La CLI (Command Line Interface) de Odoo es la forma en que se ejecuta Odoo en la mayora de los casos, ya sea en modo de desarrollo o en produccin. Conocer cmo funciona la CLI y cmo usarla de manera efectiva nos permitir aprovechar al mximo las herramientas y funciones de Odoo y mejorar la eficiencia de nuestro trabajo.

En este post, te guiar a travs de cmo acceder a la shell de Odoo y cmo configurarla para trabajar con IPython.

Cmo ejecutar una shell usando la CLI de Odoo

Para acceder a la shell de Odoo, primero debemos asegurarnos de que Odoo est instalado en nuestro sistema. Si an no lo has hecho, te recomiendo seguir los pasos de instalacin de Odoo para tu sistema operativo o Creando un entorno de desarrollo para Odoo 14.0 con VSCode. Una vez instalado, sigue estos pasos para acceder a la shell de Odoo:

Abre la lnea de comandos o terminal.
Navega hasta el directorio de instalacin de Odoo. Normalmente, esto se encuentra en "/usr/lib/odoo" o "/opt/odoo".
Ejecuta el siguiente comando si tienes una instalacion desde codigo fuente:

./odoo-bin shell -c /path/to/odoo.conf --xmlrpc-port 8888 --longpolling-port 8899

Si es desde una instalcion usando los paquetes del sistema operativo

odoo shell -c /path/to/odoo.conf --xmlrpc-port 8888 --longpolling-port 8899

-c /path/to/odoo.conf: especifica la ruta al archivo de configuracin de Odoo que deseas utilizar.
--xmlrpc-port 8888: establece el puerto XML-RPC que utiliza Odoo para comunicarse con otras aplicaciones.
--longpolling-port 8899: establece el puerto de long polling que utiliza Odoo para notificaciones en tiempo real.

Cambiamos los puertos para que no choque con los puertos de nuestra instancia de Odoo que se esta ejecutando.

Si todo funciona correctamente, deberas ver la siguiente lnea en la terminal:

env: <odoo.api.Environment object at 0x7efc89670ef0>
odoo: <module 'odoo' from '/usr/lib/python3/dist-packages/odoo/ __init__.py'>
openerp: <module 'odoo' from '/usr/lib/python3/dist-packages/odoo/ __init__.py'>
self: res.users(1,)
Python 3.x.x (default, MMM DD YYYY, HH:MM:SS)

Ahora ests en la shell de Odoo. Puedes empezar a ejecutar comandos de Odoo y explorar la plataforma ERP. Por ejemplo, puedes ejecutar el siguiente comando para el usuario que se ejecuta en esta shell Odoo:

print(self.name)

Tambin puedes interactuar con la base de datos de Odoo utilizando la sintaxis de ORM de Odoo. Por ejemplo, el siguiente comando cuenta todos los modelos de datos que tiene esta instancia de Odoo:

print(env['ir.model'].search_count([]))

Cmo configurar la interfaz de la shell para usar IPython como REPL

IPython es un shell interactivo de Python que proporciona funciones avanzadas como autocompletado, resaltado de sintaxis, historial de comandos y ms. Utilizar IPython como REPL (Read-Eval-Print Loop) en lugar del shell estndar de Python puede mejorar nuestra experiencia de programacin en Odoo.

Para configurar la shell de Odoo para usar IPython como REPL, sigue estos pasos:

Instala IPython en tu sistema. En la mayora de los sistemas operativos, puedes instalarlo ejecutando el siguiente comando:

pip install ipython

Ahora que IPython est instalado, debes modificar el comando que usamos anteriormente para acceder a la shell de Odoo, incluyendo la opcin --shell-interface ipython. El comando modificado se ver as:

# Desde codigo fuente
./odoo-bin shell -c /path/to/odoo.conf --xmlrpc-port 8888 --longpolling-port 8899 --shell-interface ipython


# Binario instalado
odoo shell -c /path/to/odoo.conf --xmlrpc-port 8888 --longpolling-port 8899 --shell-interface ipython

Al ejecutar este comando, acceders a la shell de Odoo con IPython como REPL,como vemos en la imagen, lo que te permitir aprovechar sus funciones avanzadas mientras trabajas con Odoo, para salir del modo shell con IPython debes usar ctrl+D

Recomendaciones para el uso de la shell de Odoo

Configuracin separada para la shell de Odoo

Es altamente recomendable tener un archivo de configuracin separado para la shell de Odoo. Esto nos permite ajustar los parmetros especficos para la shell sin afectar la configuracin de nuestra instancia de Odoo en produccin o desarrollo. Algunos de los parmetros que podras considerar ajustar en este archivo de configuracin separado incluyen:

--xmlrpc-port 8888: Establecer un puerto XML-RPC diferente para evitar conflictos con la instancia principal de Odoo.
--longpolling-port 8899: Establecer un puerto de Long Polling diferente para evitar conflictos con la instancia principal de Odoo.
Cambiar los valores de lmite de memoria (soft y hard memory limit) para asignar ms o menos recursos a la shell.
Ajustar el nmero de workers para adaptarlo a tus necesidades especficas.

Para crear un archivo de configuracin separado, simplemente copia tu archivo de configuracin principal y modifica los parmetros mencionados anteriormente. Luego, al ejecutar la shell de Odoo, usa la opcin -c para especificar la ruta a este nuevo archivo de configuracin. Por ejemplo:

./odoo-bin shell -c /path/to/shell-odoo.conf --shell-interface ipython


odoo- shell -c /path/to/shell-odoo.conf --shell-interface ipython

Uso de libreras externas

Al trabajar con la shell de Odoo, no ests limitado a utilizar solo las funcionalidades integradas en Odoo. Puedes aprovechar tambin las ventajas de libreras externas de Python para mejorar tu productividad y facilitar el anlisis y procesamiento de datos. Una de estas libreras es Pandas, una herramienta popular y potente para el anlisis y manipulacin de datos en Python.

Puedes importar Pandas en la shell de Odoo e interactuar con los datos utilizando sus estructuras de datos como DataFrames y Series. Por ejemplo, puedes convertir los registros de un modelo de Odoo en un DataFrame de Pandas y luego realizar anlisis y manipulacin de datos avanzados. Esto puede ser especialmente til cuando necesitas generar informes o analizar datos de forma rpida y eficiente.

Recuerda que al usar libreras externas como Pandas, es importante garantizar que estn correctamente instaladas y configuradas en tu entorno de desarrollo y, si es necesario, en el entorno de produccin.

Conclusin

En resumen, la shell de la CLI de Odoo es una herramienta muy til para los desarrolladores de Odoo que desean profundizar en la programacin del ERP. A travs de la CLI, podemos interactuar con Odoo de una manera ms avanzada y personalizada. Adems, al configurar la interfaz de la shell para usar IPython como REPL, podemos aprovechar las funciones avanzadas de IPython y mejorar nuestra experiencia de programacin en Odoo.

Espero que este post te haya sido til y te haya brindado una mejor comprensin de cmo trabajar con la shell de Odoo y configurarla con IPython. Si te ha gustado este post y crees que puede ser til para otros desarrolladores de Odoo, no dudes en compartirlo en tus redes sociales. Nos vemos en un proximo post donde profundizaremos en el uso de la shell de Odoo.

Si quieren saber mas sobre IPython y la CLI de Odoo, aca les dejo los enlaces a su documentacin.

Crea tu propio chatbot con la API de OpenAI y Gradio en Python

Rafnix Guzmán — Wed, 22 Mar 2023 19:05:18 +0000

Hoy vamos a aprender a crear una aplicacin en Python utilizando la API de OpenAI y Gradio. Esta publicacin ser til para las personas que quieren aprender a utilizar la API de OpenAI y crear una aplicacin con una interfaz de usuario interactiva de forma rapida y sin necesidad de usar HTML, CSS y Javscript.

Introduccin

Antes de empezar, debemos entender qu es la API de OpenAI y Gradio.

OpenAI es una organizacin de investigacin en inteligencia artificial. Ofrecen una API que permite acceder a modelos de inteligencia artificial avanzados para realizar diversas tareas, como responder preguntas, traducir oraciones, resumir noticias y ms.

Por otro lado, Gradio es una herramienta de cdigo abierto para crear interfaces de usuario interactivas para modelos de inteligencia artificial. Ofrece una manera fcil y rpida de crear una interfaz de usuario para cualquier modelo de aprendizaje automtico.

Ahora que tenemos una comprensin bsica de ambas herramientas, comencemos con el tutorial.

Conectando a la API de OpenAI

Para usar la API de OpenAI, necesitamos generar una clave API. Siga estos pasos para obtener su clave API:

Visite el sitio web de OpenAI y regstrese para obtener una cuenta gratuita.
Inicie sesin en su cuenta y vaya a la pgina de la API.
Cree una nueva clave API y cpiela porque la usaremos mas adelante.

Instalacin de dependencias

En este tutorial, crearemos una aplicacin de Chatbot utilizando la API de OpenAI y Gradio. Para empezar, necesitamos ubicarnos en la carpeta donde vamos a trabajar nuestro proyecto e instalar ambos paquetes en nuestra mquina. Como un paso previo a la instalacin de las dependecias se puede crear un entorno virtual de python para que las librerias no tengan colision con las del sistema:

python3 -m venv venv
source venv/bin/activate

Luego de activar el entorno virtual, procedemos a instalar las dependencias:

pip install openai
pip install gradio

Configuracin de la clave API de OpenAI

Una vez que tengamos ambos paquetes instalados, podemos comenzar a escribir nuestro cdigo.

Primero, debemos configurar la API de OpenAI para poder acceder a sus servicios. Una vez que tengamos la clave API, podemos configurarla en nuestro cdigo de Python creando un archivo llamado chatbot.py utilizando el siguiente cdigo.

import openai
import os

# Obtener la clave API de OpenAI de la variable de entorno
openai.api_key = os.environ.get("OPENAI_API_KEY", None)

Asegrate de configurar la variable de entorno OPENAI_API_KEY con tu clave API real antes de ejecutar el cdigo, sino en la ultima seccin te explico como hacerlo.

Ahora que tenemos la clave API configurada, podemos comenzar a interactuar con la API de OpenAI. En este tutorial, crearemos un chatbot que puede responder a las preguntas de los usuarios.

Configuracin del mensaje por defecto

Para crear un chatbot utilizando la API de OpenAI, necesitamos proporcionar una serie de mensajes como entrada a la API. Cada mensaje es una cadena de texto que representa el mensaje enviado por un usuario o el chatbot. Usaremos un mensaje por defecto para configurar y condicionar las respuesta GPT:

messages = [
    {
        "role": "system",
        "content": "Act like a personal assistant. You can respond to questions, translate sentences, summarize news, and give recommendations."
    }
]

En este ejemplo, el chatbot comienza presentndose como un asistente personal y proporcionando una lista de tareas que puede realizar.

Funcin de llamada a la API de OpenAI

Una vez que tenemos los mensajes de entrada preparados, podemos enviarlos a la API de OpenAI para generar una respuesta utilizando el siguiente cdigo.


def openai_process_message(user_message):
    # Set the prompt for OpenAI Api
    messages = [
        {
            "role": "system",
            "content": "Act like a personal assistant. You can respond to questions, translate sentences, summarize news, and give recommendations."
        }
    ]
    messages.append({"role": "user", "content": user_message})
    # Call the OpenAI Api to process our prompt
    openai_response = openai.ChatCompletion.create(model="gpt-3.5-turbo", messages=messages, max_tokens=2000)
    # Parse the response to get the response text for our prompt
    response_text = openai_response.choices[0].message.content
    return response_text

La funcin openai_process_message toma como entrada el mensaje del usuario y lo agrega a la lista de mensajes como un mensaje de usuario. A continuacin, llama a la API de OpenAI para procesar los mensajes y generar una respuesta. Por ltimo, la funcin devuelve la respuesta generada por la API de OpenAI.

Creacin de la UI con Gradio

A continuacin, crearemos una lista de ejemplos que se utilizarn para mostrar ejemplos en la interfaz de usuario. En este caso, utilizaremos preguntas sobre la inteligencia artificial.

examples = [
    "Que es la IA?",
    "Como funciona una red neuronal?",
    "pueden las maquinas aprender?",
]

Luego, creamos una instancia de la clase Interface de Gradio y le pasamos la funcin openai_process_message() como argumento. A continuacin, definimos el tipo de entrada y salida que deseamos para nuestra interfaz. En este caso, utilizaremos una caja de texto para la entrada del usuario y otra para mostrar la respuesta del chatbot.

# Create a Gradio interface instance
demo = gr.Interface(
    fn=openai_process_message,
    inputs=gr.Textbox(lines=5, label='Pregunta', placeholder='Escribe tu pregunta aqu...'),
    outputs=gr.Textbox(label='Respuesta'),
    examples=examples,
    title="Chatbot OpenAI API",
)

Finalmente, lanzamos la interfaz de usuario utilizando el mtodo launch().

if __name__ == " __main__":
    demo.launch()

Corriendo nuestra aplicacin

Recuerda que antes de lanzar la aplicacin, debes configurar la variable de entorno "OPENAI_API_KEY" con tu clave de API de OpenAI. Puedes hacerlo de la siguiente manera en tu terminal:

export OPENAI_API_KEY=<tu_clave_de_api>

Donde debe ser reemplazada con tu clave de API real de OpenAI.

Para lanzar la aplicacin, puedes simplemente ejecutar el archivo Python en tu terminal o IDE de Python:

python chatbot.py

Con esto ya tenemos nuestra app corriendo sobre https://127.0.0.1:7860 y con la siguiente UI de forma facil y rapida:

Conclusiones

Ahora tenemos una aplicacin completa de preguntas y respuestas que utiliza la API de OpenAI para generar respuestas a cualquier pregunta que el usuario pueda tener. Esta aplicacin es solo un ejemplo de lo que se puede hacer con la API de OpenAI y la biblioteca Gradio. Hay muchas otras aplicaciones de inteligencia artificial que se pueden crear utilizando estas herramientas.

En un proximo post voy a implementar otra UI usando el componente Chatbot de Gradio para darle un diseo mas acoorde al un chatbot y algunos otros tips a la hora de usar Gradio, por el momento es un buen punto de partida para practicar y probar estas tecnologias.

Codigo completo

# Archivo chatbot.py
import gradio as gr
import openai
import os

# Get OpenAI API Key from environment variable
openai.api_key = os.environ.get("OPENAI_API_KEY", None)

def openai_process_message(user_message):
    # Set the prompt for OpenAI Api
    messages = [
        {
            "role": "system",
            "content": "Act like a personal assistant. You can respond to questions, translate sentences, summarize news, and give recommendations."
        }
    ]
    messages.append({"role": "user", "content": user_message})
    # Call the OpenAI Api to process our prompt
    openai_response = openai.ChatCompletion.create(model="gpt-3.5-turbo", messages=messages, max_tokens=2000)
    # Parse the response to get the response text for our prompt
    response_text = openai_response.choices[0].message.content
    return response_text

examples = [
    "Que es un chatbot?",
    "podrias definir que es una IA?",
    "dime cual seria una receta para hacer salsa bechamel?",
]

demo=gr.Interface(
    fn=openai_process_message,
    inputs=gr.Textbox(lines=5, label='Pregunta',placeholder='Escribe tu pregunta'),
    outputs=gr.Textbox(label='Respuesta'),
    examples=examples,
    title="Chatbot OpenAI API",
)
if __name__ == " __main__":
    demo.launch()

Los servicios que uso en mi HomeLab server: virtualización, contenedores y más.

Rafnix Guzmán — Mon, 20 Mar 2023 23:42:31 +0000

Hola nuevamente! hoy quiero profundizar en cada uno de los servicios y aplicaciones que tengo en mi homelab server y compartirlas contigo.

Introducción

En mi camino como desarrollador y entusiasta de la tecnologa, he construido un homelab server en mi casa para experimentar con nuevas tecnologas y aprender de forma autodidacta. Es un servidor casero donde puedo ejecutar diferentes servicios y herramientas en un ambiente controlado.

En este artculo, compartir con ustedes los servicios que actualmente estoy corriendo en mi homelab server. Estos servicios incluyen virtualizacin con Proxmox, contenedores con LXC y Docker, una plataforma como servicio (PaaS) llamada Coolify, un backend as a service (BaaS) llamado Appwrite, Pi-hole para bloquear anuncios y rastreadores, Plausible para analizar las mtricas de mi sitio, y mucho ms. Si ests interesado en crear tu propio homelab server o simplemente deseas conocer qu servicios estoy usando, sigue leyendo para conocer ms.

Proxmox VE

Proxmox VE es una plataforma de virtualizacin de cdigo abierto que utilizo para virtualizar y administrar mis servidores. Proxmox me permite crear y gestionar contenedores Linux (LXC) y mquinas virtuales (VM), lo que me brinda una gran flexibilidad y ahorro de recursos en mi homelab server.

Los contenedores LXC son una forma ligera y eficiente de virtualizacin que me permiten ejecutar mltiples servicios en mi homelab server de manera aislada y segura. Por otro lado, las mquinas virtuales son una forma ms tradicional de virtualizacin que me permiten ejecutar sistemas operativos completos en mi homelab server, lo que es til para probar diferentes configuraciones y experimentar con nuevas tecnologas.

Proxmox tiene una interfaz web fcil de usar que me permite crear y gestionar mis contenedores LXC y mquinas virtuales de manera sencilla. Tambin cuenta con una comunidad activa y una amplia documentacin que me ha sido de gran ayuda a lo largo del tiempo.

Coolify

Coolify es una plataforma como servicio (PaaS) que utilizo para alojar mi sitio web. Es una alternativa a Heroku, pero self-hosted, lo que me brinda ms control y flexibilidad. Dentro de Coolify, tengo desplegado mi sitio web. Adems, utilizo Appwrite, un Backend as a Service (BaaS) del que hablare mas adelante y algunas aplicaciones desplegadas usando docker.

Appwrite

Appwrite es un Backend as a Service (BaaS) que utilizo para gestionar mi sitio web. Me ayuda a manejar fcilmente usuarios, bases de datos y autenticacin en mi sitio web, lo que me ahorra mucho tiempo y esfuerzo. Appwrite es muy fcil de integrar con Coolify, y tiene una interfaz de usuario web muy intuitiva.

Plausible

Plausible es una herramienta de anlisis web de cdigo abierto que utilizo para analizar las mtricas de mi sitio web. Es una alternativa a Google Analytics, pero ms centrada en la privacidad. Plausible utiliza una arquitectura simple y ligera que no rastrea a los usuarios y no recopila informacin personal. Plausible me brinda informacin detallada sobre el trfico de mi sitio web, como la cantidad de visitas, la ubicacin geogrfica de los visitantes y el tiempo promedio en el sitio.

Portainer

Portainer es una herramienta de gestin de contenedores de Docker que utilizo para administrar y supervisar mis contenedores. Portainer tiene una interfaz de usuario web que me permite ver fcilmente el estado de mis contenedores, administrar imgenes y supervisar logs. Utilizo Portainer para gestionar Pi-Hole y otros servicios como el speedtracker en mi homelab server.

Pi-Hole

Pi-hole es una aplicacin de bloqueo de anuncios y rastreadores en Internet que utilizo para proteger mi navegacin web y reducir la cantidad de anuncios. Pi-Hole utiliza una lista de bloqueo de anuncios actualizada regularmente para bloquear anuncios en todos mis dispositivos de red. Pi-hole funciona bloqueando las solicitudes de DNS de anuncios y rastreadores, lo que significa que la mayora de los anuncios y rastreadores simplemente no se cargan.

En mi homelab server, utilizo Pi-hole como mi servidor de DNS local y bloqueador de anuncios y rastreadores. Pi-hole es fcil de configurar y puedo personalizar las listas de bloqueo de anuncios y rastreadores segn mis necesidades. Tambin puedo ver estadsticas detalladas sobre los dominios bloqueados y la cantidad de solicitudes de DNS procesadas por Pi-hole. Es una herramienta til para mantener la privacidad y seguridad en mi red domstica.

Speedtest Tracker

Speedtest Tracker es una herramienta de monitoreo de velocidad de internet que utilizo para supervisar la velocidad de mi conexin a internet. Speedtest Tracker se ejecuta en un contenedor de Docker y utiliza Speedtest CLI para realizar pruebas de velocidad en intervalos regulares. Speedtest Tracker me brinda informacin detallada sobre la velocidad de mi conexin a internet, como la velocidad de descarga, la velocidad de carga y la latencia. Tambin puedo ver grficas de tendencias y estadsticas de velocidad a lo largo del tiempo.

Cloudflare Tunnels

Cloudflare Tunnels es un servicio que utilizo para conectar mis contenedores y mi dominio. Con Cloudflare Tunnels, puedo acceder a mis servicios de forma segura desde cualquier lugar, sin tener que preocuparme por abrir puertos en mi firewall. Cloudflare Tunnels tambin me ayuda a ocultar la direccin IP de mi servidor, lo que aumenta mi privacidad y seguridad. Si quieres conocer ms acerca de Cloudflare Tunnels, puedes visitar su sitio web.

Nginx Proxy Manager

Nginx Proxy Manager es una herramienta de gestin de proxies que utilizo para gestionar la redireccin en dominios locales junto con Pi-Hole. Nginx Proxy Manager tiene una interfaz de usuario web sencilla que me permite configurar fcilmente proxies y redirecciones para mis servicios en contenedores. Adems, Nginx Proxy Manager me ayuda a asegurar mis servicios al permitirme configurar SSL/TLS para mis dominios. Si ests interesado en conocer ms sobre Nginx Proxy Manager, puedes visitar su sitio web.

Resumen

En mi homelab server, tengo configurados varios servicios para llevar a cabo diversas tareas. Proxmox me permite virtualizar y administrar mis servidores, y utilizo tanto contenedores LXC como mquinas virtuales para ejecutar diferentes servicios y experimentar con nuevas tecnologas.

Coolify es una plataforma como servicio que utilizo para alojar mi sitio web, con un backend as a service llamado Appwrite para manejar usuarios y bases de datos. Para analizar las mtricas de mi sitio, utilizo Plausible, y para bloquear anuncios y rastreadores en mi red, utilizo Pi-hole.

Adems, utilizo Cloudflare Tunnels para conectar mis contenedores dentro de mi servidor y mi dominio de forma segura, y Nginx Proxy Manager para gestionar la redireccin en dominios locales junto con Pi-hole.

En resumen, estos son los servicios que tengo en mi homelab server y que me permiten experimentar con diferentes tecnologas y aplicaciones en un entorno seguro y controlado. Si ests interesado en crear tu propio homelab server, te recomiendo comenzar con algunos de estos servicios y experimentar para encontrar lo que mejor se adapte a tus necesidades. Que disfrutes la creacin de tu homelab server!

Creando un entorno de desarrollo para Odoo 14.0 con VSCode en Ubuntu 22.04

Rafnix Guzmán — Tue, 14 Mar 2023 13:00:39 +0000

En este artculo aprenders a configurar un entorno de desarrollo para Odoo 14.0 en Ubuntu 22.04. Si ests leyendo esto, probablemente ya sabes que Odoo es un ERP basado en Python, PostgreSQL y XML que permite a las empresas gestionar sus procesos empresariales de manera integrada.

Antes de empezar con la configuracin del entorno de desarrollo, asegrate de tener instalado los siguientes requisitos previos: Python 3, Git, PostgreSQL y VSCode. Si an no los tienes, puedes seguir los siguientes enlaces para instalarlos:

Python 3: https://www.python.org/downloads/
Git: https://git-scm.com/downloads
PostgreSQL: https://www.postgresql.org/download/
VSCode: https://code.visualstudio.com/download

Una vez que tengas estos requisitos previos instalados, ests listo para empezar a configurar tu entorno de desarrollo de Odoo. En este post, te enseare cmo crear una estructura de carpetas adecuada para trabajar con Odoo y cmo configurar VSCode para poder debuggear el cdigo.

Instalacin de PostgreSQL

Para trabajar con Odoo, necesitars tener instalado PostgreSQL. PostgreSQL es un sistema de gestin de bases de datos relacional de cdigo abierto. Para instalar PostgreSQL en Ubuntu/Debian, puede seguir los siguientes pasos en la terminal:

sudo apt update
sudo apt upgrade
sudo apt install postgresql postgresql-client
sudo -u postgres createuser -s $USER
createdb odoo-dev-14.0

sudo apt update: Este comando se utiliza para actualizar la lista de paquetes disponibles en los repositorios de Ubuntu/Debian. Es importante ejecutar este comando antes de instalar cualquier software nuevo en Ubuntu para asegurarse de que se estn utilizando las versiones ms recientes de los paquetes disponibles.
sudo apt upgrade: Este comando se utiliza para actualizar los paquetes existentes en el sistema operativo. Al ejecutar este comando, se descargarn e instalarn las actualizaciones disponibles para todos los paquetes instalados en el sistema.
sudo apt install postgresql postgresql-client: Estos comandos se utilizan para instalar PostgreSQL y su cliente en el sistema operativo. PostgreSQL es un sistema de gestin de bases de datos relacionales que se utiliza comnmente como base de datos para Odoo.
sudo -u postgres createuser -s $USER: Este comando se utiliza para crear un usuario en PostgreSQL con todos los privilegios necesarios para trabajar con Odoo. El comando se ejecuta como el usuario "postgres", que es el usuario por defecto de PostgreSQL. $USER es una variable de entorno que contiene el nombre de usuario actual.
createdb odoo-dev-14.0: Este comando se utiliza para crear una nueva base de datos en PostgreSQL llamada "odoo-dev-14.0". Esta ser la base de datos que se utilizar para desarrollar y probar Odoo en este entorno de desarrollo.

Es importante destacar que despus de la instalacin, es necesario realizar algunas configuraciones de seguridad adicionales para garantizar la proteccin de los datos de la empresa. Sin embargo, para fines de este tutorial y dado que nos encontramos en un ambiente de desarrollo, no profundizaremos en este aspecto

Instalacin de dependencias

Antes de empezar a trabajar con Odoo, necesitamos instalar algunas dependencias en nuestro sistema operativo. Para hacerlo, podemos seguir las instrucciones oficiales que recomiendan utilizar los siguientes comandos en la terminal:

sudo apt update
sudo apt upgrade
sudo apt install python3-dev python3-pip python3-venv libxml2-dev \
libxslt1-dev libldap2-dev libsasl2-dev libtiff5-dev \
libjpeg8-dev libopenjp2-7-dev zlib1g-dev libfreetype6-dev \
liblcms2-dev libwebp-dev libharfbuzz-dev libfribidi-dev libxcb1-dev libpq-dev

Estos comandos nos permitirn instalar todas las dependencias necesarias para trabajar con Odoo en nuestro sistema Ubuntu 22.04. Es importante asegurarse de que todas las dependencias se instalen correctamente antes de continuar con la configuracin de nuestro entorno de desarrollo.

Creacin de la estructura de carpetas

Una vez instalado PostgreSQL y las dependencias necesarias, es hora de crear una estructura de carpetas para trabajar con Odoo. Para ello, ejecuta en la terminal el siguiente comando:

mkdir -p ~/Odoo/{src,workspaces,instances,instances/odoo-dev-14.0}

Esta una forma abreviada de crear varias carpetas a la vez utilizando llaves y una lista de nombres de carpeta separados por comas.

En este caso, el comando crea una estructura de carpetas dentro de la carpeta principal del usuario (representado por el smbolo "~" que se refiere al directorio de inicio del usuario) con los siguientes nombres de carpeta:

src
workspaces
instances
instances/odoo-dev-14.0

La opcin "-p" indica que se crearn todas las carpetas necesarias en la ruta, incluso si algunas de ellas ya existen. De esta manera, se crea una estructura de carpetas adecuada para trabajar con Odoo y se asegura de que todas las carpetas necesarias estn disponibles en el directorio de inicio del usuario.

Instalacin de Odoo 14.0

Ahora que hemos instalado PostgreSQL, Python y las dependencias necesarias, podemos proceder a instalar Odoo.

Descargar el cdigo fuente de Odoo 14.0

Para descargar el cdigo fuente de Odoo 14.0, ejecuta en la terminal el siguiente comando:

git clone https://github.com/odoo/odoo.git --single-branch --depth 1 --branch 14.0 ~/Odoo/src/14.0

Este comando descargar el cdigo fuente de Odoo 14.0 en la carpeta ~/Odoo/src/14.0.

El parmetro --single-branch indica que solo se clonar la rama especificada en lugar de todas las ramas del repositorio. El parmetro --depth 1 indica que solo se clonar el historial ms reciente del repositorio, lo que reduce el tiempo y espacio necesarios para la descarga.

Crear un entorno virtual

Para crear un entorno virtual de Python para Odoo, ejecute el siguiente comando:

python3 -m venv ~/Odoo/instances/odoo-dev-14.0/venv

Este comando crear un entorno virtual para Odoo en la carpeta ~/Odoo/instances/odoo-dev-14.0/venv.

Instalar las dependencias de Odoo

Para instalar las dependencias de python para Odoo, ejecute los siguientes comandos:

source ~/Odoo/instances/odoo-dev-14.0/venv/bin/activate
pip3 install setuptools wheel inotify psycopg2-binary
pip3 install -r ~/Odoo/src/14.0/requirements.txt
deactivate

Estos comandos activarn el entorno virtual de Odoo, instalarn las dependencias necesarias y desactivarn el entorno virtual.

source ~/Odoo/instances/odoo-dev-14.0/venv/bin/activate: este comando activa el entorno virtual de Odoo para que puedas instalar las dependencias necesarias sin afectar al sistema operativo.
pip3 install setuptools wheel inotify psycopg2-binary: estos son paquetes de Python necesarios para ejecutar Odoo. setuptools y wheel son herramientas de construccin de paquetes, inotify es una biblioteca para monitorear cambios en archivos y directorios, y psycopg2-binary es un controlador de base de datos PostgreSQL para Python.
pip3 install -r ~/Odoo/src/14.0/requirements.txt: este comando instala todas las dependencias adicionales requeridas por Odoo, que estn enumeradas en el archivo requirements.txt. El prefijo -r significa "de un archivo de requisitos".
deactivate: este comando desactiva el entorno virtual de Odoo, lo que significa que ya no se estn utilizando las dependencias instaladas en dicho entorno.

Con estos pasos, hemos instalado Odoo 14.0 en nuestro entorno de desarrollo de Ubuntu 22.04. Ahora podemos empezar a trabajar con Odoo y personalizarlo segn nuestras necesidades.

Crear el archivo de configuracin de Odoo

Despus de haber creado el entorno virtual de Python y haber instalado las dependencias necesarias, el siguiente paso es configurar Odoo para que se ejecute correctamente en el entorno virtual. Para esto, es necesario crear un archivo de configuracin especfico para su instancia de Odoo.

Para crear el archivo de configuracin, ejecute los siguientes comandos:

cp ~/Odoo/src/14.0/debian/odoo.conf ~/Odoo/instances/odoo-dev-14.0 
sed -i 's/db_user = odoo/db_user = '$USER'/' ~/Odoo/instances/odoo-dev-14.0/odoo.conf

El primer comando copia el archivo de configuracin predeterminado de Odoo a la carpeta de su instancia de Odoo. El segundo comando utiliza el comando "sed" para reemplazar el usuario de la base de datos predeterminado de "odoo" por el usuario actual. Esto es necesario para que Odoo pueda acceder a la base de datos en el entorno virtual.

Una vez que haya creado el archivo de configuracin de Odoo, podr personalizarlo para adaptarlo a sus necesidades especficas. Puede configurar la direccin IP, el puerto, la base de datos y otras opciones para su instancia de Odoo si ya tenia una instalacin de PostgreSQL.

Inicializar la base de datos de Odoo

Una vez que se han instalado las dependencias de Odoo y se ha creado el archivo de configuracin, el siguiente paso es inicializar la base de datos de Odoo. Para hacer esto, se utilizar el comando:

~/Odoo/instances/odoo-dev-14.0/venv/bin/python3 ~/Odoo/src/14.0/odoo-bin -c ~/Odoo/instances/odoo-dev-14.0/odoo.conf -d odoo-dev-14.0 -i base --stop-after-init

Este comando ejecuta el archivo odoo-bin que se encuentra en la carpeta src/14.0 del directorio raz de Odoo. El parmetro -c especifica la ruta del archivo de configuracin de Odoo que se cre anteriormente. El parmetro -d especifica el nombre de la base de datos que se crear e inicializar. En este caso, se est utilizando odoo-dev-14.0.

El parmetro -i indica los mdulos de Odoo que se instalarn. En este caso, solo se est instalando el mdulo base de Odoo. Sin embargo, es posible agregar ms mdulos separndolos por comas.

Finalmente, el parmetro --stop-after-init detiene el servidor de Odoo despus de inicializar la base de datos. Esto es til si solo se desea inicializar la base de datos y no ejecutar el servidor completo de Odoo.

Una vez que se ejecuta este comando, se crear y se inicializar la base de datos de Odoo. Este proceso puede tardar unos minutos, dependiendo de la velocidad de su computadora.

Configuracin del debugger de VSCode para Odoo 14.0

Una herramienta til para desarrollar en Odoo es el debugger de Visual Studio Code (VSCode), que permite depurar cdigo en tiempo real. A continuacin, se muestra cmo configurar el debugger de VSCode para trabajar con Odoo 14.0.

Abre Visual Studio Code en la carpta de la instancia ~/Odoo/instances/odoo-dev-14.0/ y haz clic en la pestaa "Debug" en la barra lateral izquierda.
Haz clic en el botn "cree un archivo launch.json" en la parte inferior de la pestaa "Debug".
Copia y pega el siguiente cdigo en el archivo "launch.json" que se ha creado:

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "odoo-dev-14.0",
            "type": "python",
            "request": "launch",
            "program": "~/Odoo/src/14.0/odoo-bin",
            "console": "integratedTerminal",
            "args": [
                "-c","~/Odoo/instances/odoo-dev-14.0/odoo.conf",
                "--limit-time-real", "99999",
                "-d", "odoo-dev-14.0"
            ]
        },
        {
            "name": "odoo-dev-14.0-install-addons",
            "type": "python",
            "request": "launch",
            "program": "~/Odoo/src/14.0/odoo-bin",
            "console": "integratedTerminal",
            "args": [
                "-c","~/Odoo/instances/odoo-dev-14.0/odoo.conf",
                "--limit-time-real", "99999",
                "-d", "odoo-dev-14.0",
                "-i","",
                "--stop-after-init"
            ]
        },
        {
            "name": "odoo-dev-14.0-update-addons",
            "type": "python",
            "request": "launch",
            "program": "~/Odoo/src/14.0/odoo-bin",
            "console": "integratedTerminal",
            "args": [
                "-c","~/Odoo/instances/odoo-dev-14.0/odoo.conf",
                "--limit-time-real", "99999",
                "-d", "odoo-dev-14.0",
                "-u","",
                "--stop-after-init"
            ]
        },
        {
            "name": "odoo-dev-14.0-repl",
            "type": "python",
            "request": "launch",
            "program": "~/Odoo/src/14.0/odoo-bin",
            "console": "integratedTerminal",
            "args": [
                "shell",
                "-c","~/Odoo/instances/odoo-dev-14.0/odoo.conf",
                "--limit-time-real", "99999",
                "--xmlrpc-port","8888",
                "--longpolling-port","8899",
                "-d", "odoo-dev-14.0",
                "--shell-interface", "ipython"
            ]
        }
    ]
}

Ahora, puedes elegir una de las siguientes opciones de configuracin del debugger:

odoo-dev-14.0: esta opcin inicia Odoo en modo de desarrollo con la base de datos "odoo-dev-14.0".
odoo-dev-14.0-install-addons: esta opcin instala los mdulos de Odoo que agregemos al parametro "-i", en la base de datos "odoo-dev-14.0".
odoo-dev-14.0-update-addons: esta opcin actualiza los mdulos de Odoo que agregemos al parametro "-u", en la base de datos "odoo-dev-14.0".
odoo-dev-14.0-repl: esta opcion inicia Odoo en modo de consola interactiva (REPL) donde puedes ejecutar comandos del ORM

El parametro "--limit-time-real" establece el tiempo mximo permitido para la ejecucin de una solicitud de servidor en Odoo, con un valor de "99999" establece este lmite en un tiempo muy alto, prcticamente ilimitado. Esto es til durante el desarrollo, ya que nos permite depurar el cdigo sin interrupciones debido a la expiracin del tiempo lmite de Odoo

Con la configuracin adecuada, podemos utilizar el debugger de VSCode para solucionar problemas en el cdigo de Odoo y mejorar la calidad del software. Adems, al tener un debugger integrado en su entorno de desarrollo, pueden ahorrar tiempo y mejorar la eficiencia de su trabajo.

Espero que este tutorial haya sido til para aquellos que buscan configurar el debugger de VSCode para trabajar con Odoo 14.0. Si tienes alguna pregunta o comentario, no dudes en escribirme.

Creando tu primer HomeLab Server: Consideraciones clave para empezar

Rafnix Guzmán — Fri, 10 Mar 2023 00:15:50 +0000

Ests interesado en crear tu propio homelab server pero no sabes por dnde empezar? Aqu te presentamos algunas consideraciones clave que debes tener en cuenta para planificar y armar tu homelab.

Por qu tener un homelab es importante

Un homelab es una infraestructura de tecnologa personal que te permite experimentar y aprender de una manera prctica cmo funcionan diferentes sistemas operativos, aplicaciones y servicios. Adems, tener tu propio homelab te da la libertad de tener el control total sobre tus aplicaciones, datos y recursos. Tambin te permite realizar pruebas en un ambiente controlado y seguro sin afectar los sistemas de produccin en una empresa.

No es necesario hardware empresarial

A menudo, la gente piensa que es necesario tener hardware empresarial costoso para crear un homelab server. Sin embargo, esto no es cierto. Para proyectos personales o pequeas empresas, no es necesario tener un servidor costoso y de alta gama. Un equipo de escritorio potente puede ser suficiente para comenzar, siempre y cuando se planifique cuidadosamente la configuracin de hardware.

Cmo planificar el armado de tu homelab server

Antes de planificar la configuracin de hardware para tu homelab server, debes tener claro el objetivo de tu homelab y los proyectos que deseas ejecutar. Esto te permitir determinar los requerimientos de hardware que vas a necesitar. A continuacin, algunos factores clave que debes considerar:

Procesador

El procesador es uno de los componentes ms importantes de cualquier servidor. Se recomienda tener al menos un procesador de multiples nucleos, minimo 2. Para un mejor rendimiento, se recomienda optar por procesadores de la serie i7 de Intel o la serie Ryzen 7 de AMD estos proporcionar suficiente potencia de procesamiento para ejecutar varias aplicaciones y servicios simultneamente.

RAM

La memoria RAM es otro componente crtico en la construccin de un homelab server, especialmente si planeas ejecutar varias mquinas virtuales al mismo tiempo. Se recomienda tener al menos 16 GB o 32 GB de RAM para asegurar un rendimiento ptimo. Si tienes un presupuesto ajustado, puedes empezar con 8 GB de RAM y luego actualizar a medida que sea necesario.

Almacenamiento

En cuanto al almacenamiento, hay varias opciones disponibles. Aunque los SSD son ms rpidos y fiables que los discos duros tradicionales (HDD), tambin son ms caros. Para proyectos personales o pequeas empresas, un disco duro HDD de alta capacidad puede ser una opcin ms econmica. Un disco duro de 1 TB o ms es suficiente para la mayora de las necesidades de almacenamiento.

Conexin a red

La conexin a red es crucial para el rendimiento del servidor. Asegrate de tener una tarjeta de red Gigabit Ethernet para un rendimiento ptimo. Si planeas configurar tu servidor como un router o firewall, considera utilizar una tarjeta de red con mltiples puertos.

Equipos pre-armados de bajo consumo

Existen diversas opciones de equipos pre-armados de poco consumo que pueden ser utilizados como servidores para proyectos personales o pequeas empresas:

Raspberry Pi: La Raspberry Pi es una pequea computadora de bajo costo que consume muy poca energa. Es perfecta para ejecutar aplicaciones de servidor livianas.
Odroid: Odroid es otra pequea computadora similar a la Raspberry Pi. Tambin consume muy poca energa y es capaz de ejecutar aplicaciones de servidor.

Crear tu propio servidor homelab puede ser una experiencia emocionante y valiosa. Te permite aprender y experimentar en un entorno controlado, lo que te ayuda a desarrollar habilidades tiles en el mundo de la tecnologa e informtica.

Actualiza tu perfil de GitHub con README y GitHub Actions - Parte 3

Rafnix Guzmán — Sun, 09 Aug 2020 00:59:16 +0000

Si aun no has leído las otras dos partes te invito a que las revises:

En esta tercera entrega vamos a automatizar mediante GitHub Actions la generación de nuestro archivo README.md ejecutando de forma programada nuestro script de Python que creamos en la publicación anterior.

GitHub Actions es una funcionalidad de GitHub que nos permite automatizar flujos de desarrollo directamente en nuestro repositorio de código, lo que nos da la ventaja de poder crear nuestros propios flujos y trabajos a ejecutar.

Al estar integrado con nuestro repositorio de código, tenemos la ventaja de poder crear nuestros flujos de trabajo de CI/CD, en esta publicación no profundizaremos en este tipo de implementaciones, pero si haremos uso de GitGub Actions para ejecutar nuestro propio flujo que consiste en ejecutar un script de Python y realizar un PUSH a nuestro repositorio de datos cuando exista un cambio en el archivo README.md.

Creando nuestro primer GitHub Actions

Para poder activar esta funcionalidad solo debemos crear un directorio en la raíz de nuestro proyecto llamado .github dentro de este directorio creamos otro directorio llamado _ workflows._

$ mkdir .github
$ cd .github
$ mkdir workflows

Ya con esto podemos comenzara crear nuestro workflow usando un archivo YAML, para este caso mi archivo se va a llamar python-app.yml pero puede tener el nombre que ustedes quieran.

Si hacemos un push al repositorio y revisamos el tab de "Actions" veremos nuestro workflow y estará en un estado de falla ya que aun no hemos agregado ningún trabajo ni los pasos a seguir.

# Raíz del proyecto
$ git add .github/workflows/python-app.yml
$ git commit -m "[ADD] new workflow for GitHub Actions"
$ git push origin master

GitHub Actions tab

Para editar nuestro archivo lo haremos directamente desde GitHub para aprovechar el auto completado y otras herramientas que tiene GitHub para la creación de Actions, al abrir nuestro archivo escribimos lo siguiente:

Editor de GitHub

Acá podemos ver del lado derecho un panel que nos puede ayudar a buscar Actions creadas por la comunidad y también nos muestra la documentación de GitHub Actions.

name: Python workflow # Nombre del workflow
on: # llave que indica que se realizara una acción sobre algun evento 
  schedule: # El evento que ejecutara la acción
    - cron: "0 */6 * * *" # configuración del intervalo de ejecución

Pudimos haber hecho que esta acción se ejecutara con otros eventos como un push o un pull request, pero de esto hablare en una siguiente publicación, para profundizar les recomiendo estas dos lecturas:

[

Workflow syntax for GitHub Actions - GitHub Docs

A workflow is a configurable automated process made up of one or more jobs. You must create a YAML file to define your workflow configuration.

GitHub Docs

](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#onschedule)

[

Events that trigger workflows - GitHub Docs

You can configure your workflows to run when specific activity on GitHub happens, at a scheduled time, or when an event outside of GitHub occurs.

GitHub Docs

](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#scheduled-events)

Hasta este momento solo hemos indicado, el nombre de nuestro workflow y que sera una acción que se ejecutara de forma programada cada 6 horas, pero aun no hemos definido el job y la secuencia de pasos que se van a ejecutar, para esto debemos editar nuestro archivo y nos debe quedar de la siguiente manera:

name: Python workflow # Nombre del workflow
on: # llave que indica que se realizara una acción sobre algun evento 
  schedule: # El evento que ejecutara la acción
    - cron: "0 */6 * * *" # configuración del intervalo de ejecución

jobs:
  build:

    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v2
      - name: Set up Python 3.8
        uses: actions/setup-python@v2
        with:
          python-version: 3.8
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install -r requirements.txt
      - name: Run script
        run: |
          python app.py
          git config user.name rafnixg
          git config user.email rafnixg@gmail.com
          git add README.md
          git diff --quiet && git diff --staged --quiet || git commit -m "[BOT] Update README with latest info"
          git push origin master

https://github.com/rafnixg/rafnixg/blob/master/.github/workflows/python-app.yml

Al guardar los cambios en nuestro archivo tenemos ya definido un job de nombre build con el key run-on donde indicamos que el sistema operativo que va a correr es un ubuntu-latest, si han trabajado con este tipo de archivos YAML en docker, se les hará fácil comprender este archivo, sino no hay problema acá explico que hace nuestro archivo.

Después de la definición del jobs tenemos que definir los steps, que son esos pasos que va a seguir nuestro job, aqui usamos dos actions que están disponibles en el marketplace, esta creo es una de las cosas mas interesantes de GitHub Actions, ya que podemos crear actions y compartirlas con la comunidad para que otras personas las puedan implementar, yo estaré usando en esta oportunidad "action/checkout@v2" que nos ayuda a configurar git en nuestro workspace y poder tener acceso desde el Workflow que estamos definiendo hacia nuestro repositorio y "action/setup-python@v2" que nos ayuda a configurar python en el workspace para poder correr nuestro script.

Lo siguiente sera actualizar pip e instalar las dependencias de nuestro script y ejecutar nuestro script, ya en este punto tenemos nuestro archivo READM.md actualizado en nuestro workspace , solo nos resta crear un commit con este cambio y hacer push a nuestro repositorio.

Con este push ya tenemos nuestro README.md actualizado en nuestro repositorio, ahora cada 6 horas va a correr este Workflow en donde definimos un jobs que se encarga de correr nuestro script y hacer un commit cuando exista un cambio en el archivo README.md

En próximas publicaciones hablara un poco mas sobre las GitHubs Actions y de como crear nuestras propias actions y publicarlas para que puedan ser reutilizadas, si te gusto el contenido espero tu comentario.

Sígueme en twitter @rafnixg

Referencias

[

Features • GitHub Actions

Easily build, package, release, update, and deploy your project in any language—on GitHub or any external system—without having to run code yourself.

GitHub

](https://github.com/features/actions)

[

GitHub Actions Documentation - GitHub Docs

Automate, customize, and execute your software development workflows right in your repository with GitHub Actions. You can discover, create, and share actions to perform any job you’d like, including CI/CD, and combine actions in a completely customized workflow.

GitHub Docs

](https://docs.github.com/en/actions)

[

Using Python with GitHub Actions - GitHub Docs

You can create a continuous integration (CI) workflow to build and test your Python project.

GitHub Docs

](https://docs.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#requirements-file)

Actualiza tu perfil de GitHub con README y GitHub Actions - Parte 2

Rafnix Guzmán — Wed, 29 Jul 2020 19:24:33 +0000

La idea principal es poder generar un archivo README.md con una lista de los últimos 5 post de este Blog, pero en esencia este código con muy poco o hasta nula modificacion en algunos casos puede servir para otros servicios como dev.to, Medium o WordPress.

Ya teniendo nuestro archivo README.md creado en el post Actualiza tu perfil de GitHub con README y Github Actions - Parte 1 , nos ubicamos en la carpeta de nuestro proyecto y empezaremos creamos una copia de nuestro archivo pero con extensión .template , quedándonos algo como esto: README.md.template, este sera el archivo que usaremos como base para generar nuestro README.md

Luego editamos la sección de "Latest post (Spanish)" sustituyendo nuestros post estáticos con este código en Jinja2, que nos ayuda a iterar sobre una lista de post.

## Latest Posts (Spanish)

{% for post in latest_post %}
- [{{post.title}}]({{post.link}})
{% endfor %}

En esta plantilla indico que le voy a pasar latest_post y que debo recorrer sus post e imprimirlos dentro de un link en markdown.

Ahora necesitamos el endpoint a el que consultaremos para obtener nuestras lista de posts, para esto haré uso de las RSS que tiene Ghost y con el siguiente servicio lo convertiré de XML a JSON

https://rss2json.com

Acá pudimos haberlo hecho de muchas maneras distintas, se pudo haber usado la API ded Ghost y hacer la peticion directa o se pudo haber hecho el cambio de XML a JSON usando Python, mi idea era hacerlo lo mas simple posible, si tienes una idea mejor la espero en los comentarios o un Pull Request, ya con esto aclarado podemos continuar xD.

Teniendo nuestro endpoint listo procederemos a crear nuestro script en Python, por lo que primero debemos preparar, es nuestro entorno virtual que nos ayude a aislar nuestras dependencias para este proyecto, podemos hacer uso de Pipenv del cual tengo un tutorial por acá (Entornos virtuales en python usando Pipenv), pero en este caso lo haremos de la siguiente manera ya que es la mas común.

$ python3 -m venv env
$ source env/bin/activate
$ touch app.py

Lo que creara una carpeta env en el root de nuestro proyecto, activara nuestro entorno virtual y crea nuestro archivo app.py

Para poder usar nuestras librerías debemos instalarlas, en este caso haré uso de PIP que es nuestro gestor de paquetes en python y las librería a instalar son:

urllib3 : Para realizar las consultas HTTP
json : para parsear la información recibida en la respuesta HTTP
jinja2 : para renderizar nuestro archivo README con la potencia de esta librería de plantillas

$ pip install urllib3 json jinja2
$ pip freeze > requirements.txt

Ya tenemos nuestras dependencias instaladas nuestras dependencias, así que procederemos a crear nuestro script, quedándonos algo como esto:

import json
import urllib3
from jinja2 import Environment, FileSystemLoader

# Cantidad maxima de posts a mostrar
MAX_POSTS = 5

# Setup
env = Environment(loader=FileSystemLoader('.'))
http = urllib3.PoolManager()

def get_latest_posts(max_posts=5):
    r = http.request('GET', 'https://api.rss2json.com/v1/api.json?rss_url=https%3A%2F%2Frafnixg.dev%2Frss%2F')
    data = json.loads(r.data.decode('utf-8'))['items']
    return data[0:max_posts]

def render_readme(data):
    template = env.get_template('README.template')
    render = template.render(**data)
    with open("README.md", "w") as f:
        f.write(render)

def main():

    latest_posts = get_latest_posts(MAX_POSTS)
    data = {
        'latest_post': latest_posts
    }
    render_readme(data)

if __name__ == " __main__":
    main()

Las primeras 3 lineas de nuestro código son básicamente la importación de las librerías y utilidades que vamos a usar, luego definimos una constante para el numero máximo de post que vamos a escribir en nuestro archivo README.

El setup es donde indicamos a jinja en que fichero debe buscar los templates y creamos una instancia que llamaremos http para nuestras consultas HTTP

Como ven en la función get_latest_posts() es un simple petición GET a el enpoint, como parámetro le podemos limitar el numero de items que retornara

En la función render_readme() indicamos el archivo a usar como template, cargamos la data obtenida de los últimos post y lo renderizamos en nuestro template para luego escribirlo en el archivo final README.md

Con esto ya podemos correr nuestro script y ver como nos genera de forma dinámica nuestro archivo README.md

$ ptyhon3 app.py

Nuestro script ya genere de forma dinámica nuestro archivo README.md, con este mismo enfoque se pueden agregar muchísimas mas funciones consultando a diferentes servicios y editar desde el template como se va a renderizar esta información.

En la tercera y ultima parte veremos como automatizar la ejecución de nuestro script y actualizar README.md en nuestro repositorio de GitHub, gracias a las GitHub Actions.

Gracias por leerme y los espero por twitter @rafnixg y su estrella en GitHub rafnixg

Actualiza tu perfil de GitHub con README y GitHub Actions - Parte 1

Rafnix Guzmán — Tue, 28 Jul 2020 21:35:14 +0000

Esta sera una serie de 3 Post:

Crear nuestro README en GitHub
Escribir un script en python para crear nuestro README dinámico
Implementar GitHub Actions para automatizar nuestro README

Acá te dejo una mirada de como quedo mi perfil, espero me dejes una estrella :D

Preparando nuestro repositorio

Para iniciar, debemos crear un repositorio en GitHub con nuestro nombre de usuario, en mi caso "rafnixg", tiene que ser publico y estar inicializado con un archivo README.

Ingresando a https://github.com/new podemos crear nuestro repositorio

En mi caso ya me indica que tengo este repositorio creado, pero ademas se ve un mensaje que nos indica que activamos esta funcionalidad "secreta"

Creando nuestro README

En esta parte del proceso tendremos que empezar clonando nuestro repositorio y editar nuestro archivo README con la información que quisiéramos mostrar, para esto usaremos el siguiente comando de Git:

$ git clone https://github.com/tu_username/tu_username.git

Luego de clonar nuestro repositorio procedemos a crear nuestro archivo README usando Markdown, yo en esta parte del proceso use varias referencias para tomar ideas y armar algo que me gustara, les dejo por acá los enlaces para que las visiten y tomen ideas.

Ya con una idea de lo que queremos hacer, escribimos nuestro archivo y subimos estos cambios a GitHub

$ git add README.md
$ git commit -m "[IMP] Mejora de nuestro README"
$ git push -u origin master

Con esto ya tendremos nuestro archivo README desplegado en nuestro perfil de GitHub.

En la segunda entrega veremos como poder obtener datos de una API como la Ghost o Dev.to y actualizar nuestro archivo README usando Python.

Gracias por leerme! los espero por mi twitter @rafnixg

Crea tu blog con python usando GitHub Pages y Pelican

Rafnix Guzmán — Sat, 18 May 2019 15:30:00 +0000

Cuando comencé a darle vuelta a la idea de empezar un blog de nuevo me vinieron muchas ideas de como hacerlo a la mente, como el de usar el famoso Wordpress, teniendo en cuenta que el blog lo quería hacer para hablar un poco de python y las tecnologías que iba a ir conociendo y aprendiendo decidí mejor usar Pelican ya que esta desarrollado en Python.

¿Qué es Pelican?

Pelican es un generador de sitios estáticos desarrollado en python que nos permite escribir los post en archivos escritos en reStructuredText, Markdown, o AsciiDoc, y estos serán luego procesados para generar un sitio web estático como este blog, por lo que no necesitaremos una base de datos ni un servidor web que soporte un lenguaje de Backend como lo es GitHub Pages.

¿Qué es GitHub Pages?

GitHub Pages es un hosting de sitios estáticos y como su página web lo indica, está diseñado para hostear directamente en un repositorio de GitHub la página web de nuestros proyecto, paginas personales o de organizaciones, además de ser un servicio gratuito.

Gracias a estas características, podemos fácilmente crear nuestros sitios estáticos y subirlos a un repositorio de GitHub que debe tener la siguiente estructura username.github.io mas adelante indicaré como crear y configurar el repositorio para que pueda servir nuestro sitio web.

GitHub recomienda el uso de Jekyll para generar nuestros sitios estáticos, pero este esta hecho en Ruby, lo que no es un problema si usas Ruby pero yo al ser un #PythonLover decidí usar Pelican que esta desarrollado en Python.

Creando nuestro repositorio en GitHub

Esta parte es la más sencilla de post, ya que solo debemos entrar a nuestra cuenta de GitHub y crear un nuevo repositorio público, que tenga el siguiente nombre.

tu_username.github.io, en mi caso el repositorio donde se aloja este blog se llama rafnixg.github.io

Solo con esto ya tendremos nuestro Github Pages listo para comenzar a subir nuestro contenido estático.

Instalando y configurando Pelican

Instalar y tener Pelican funcionando es super sencillo. Pero si les quiero recomendar que toda la instalación se haga en un entorno virtual usando Pipenv, para mantener separado esta instalación de los demás paquetes de Python que tengan instalados en sus sistema, si no saben como usar Pipenv acá les dejo un post que tengo sobre este tema, Entornos virtuales en Python usando Pipenv.

Antes de iniciar con la instalación de pelican, debemos clonar nuestro repositorio donde está hosteada nuestro blog, para esto solo debemos ubicarnos donde queramos tener nuestro proyecto, en este caso yo lo haré en la raíz de mi sistema.

$ cd ~ $ git clone https://github.com/tu_username/tu_username.github.io.git 
$ cd tu_username.github.io

Luego de esto, procedemos a instalar nuestro Pelican, lo primero que debemos hacer es crear un nuevo branch llamado source donde irá todo nuestro código fuente y librerías, ya que para GitHub todo lo que esté en la rama master es lo que será servido, para nuestro interés solo debemos subir a master lo que pelican genera en su carpeta output, pero más adelante nos preocuparemos de esto.

$ git checkout -b source
$ pipenv shell

Con esto ya tendremos nuestro entorno virtual para nuestra instalación de pelican, ahora procedemos a instalar pelican que es nuestro generador de sitios estáticos, markdown que nos ayudará para escribir nuestros post usando este lenguaje y ghp-import que nos ayuda a publicar nuestro sitio a GitHub.

$ pipenv install pelican markdown ghp-import 
Installing pelican… 
Adding pelican to Pipfile's [packages]…
✔ Installation Succeeded 
Installing markdown…
Adding markdown to Pipfile's [packages]… 
✔ Installation Succeeded 
Installing ghp-import… 
Adding ghp-import to Pipfile's [packages]… 
✔ Installation Succeeded 
Pipfile.lock not found, creating… 
Locking [dev-packages] dependencies… 
Locking [packages] dependencies… 
✔ Success! 
Updated Pipfile.lock (b0c318)! 
Installing dependencies from Pipfile.lock (b0c318)… 
🐍 ▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉ 13/13 —

Ya con esto tenemos todo listo para empezar a usar Pelican, así que creemos nuestro primer blog usándolo.

$ pelican-quickstart 
Welcome to pelican-quickstart v4.0.1. 
This script will help you create a new Pelican-based website. 
Please answer the following questions so this script can generate the files needed by Pelican. 
Using project associated with current virtual environment.Will save to:
/home/username/blog/pelican
> What will be the title of this web site? prueba pelican 
> Who will be the author of this web site? rafnix guzman 
> What will be the default language of this web site? [es] es 
> Do you want to specify a URL prefix? e.g., https://example.com (Y/n) n 
> Do you want to enable article pagination? (Y/n) y 
> How many articles per page do you want? [10] 
> What is your time zone? [Europe/Paris] America/Lima 
> Do you want to generate a tasks.py/Makefile to automate generation and publishing? (Y/n) Y # Responder Y, esto nos ayuda mucho! 
> Do you want to upload your website using FTP? (y/N) n 
> Do you want to upload your website using SSH? (y/N) n 
> Do you want to upload your website using Dropbox? (y/N) n 
> Do you want to upload your website using S3? (y/N) n 
> Do you want to upload your website using Rackspace Cloud Files? (y/N) n 
> Do you want to upload your website using GitHub Pages? (y/N) y 
> Is this your personal page (username.github.io)? (y/N) y 
Done. Your new project is available at /home/username/blog/pelican

Si tienen alguna duda respecto a la zona horaria aca les dejo una lista con todas las zonas horarias

> Do you want to generate a tasks.py/Makefile to automate generation and publishing? (Y/n)

A esta pregunta deben responder (Y), ya que este Makefile nos ayudará a generar nuestro sitio de forma más fácil, como podemos ver ya con esto se nos ha generado nuestro proyecto de pelican con el que podemos empezar a trabajar.

Escribiendo nuestro primer post

Vamos a crear nuestro primer post, para esto nos debemos ubicar en la carpeta content y con nuestro editor de texto favorito procedemos a crear un archivo llamado hola-mundo.md (si, lo se, la imaginación está a la orden del día), este archivo luego puede ser borrado es solo para pruebas.

Title: Hola Mundo
Date: 2019-05-18 10:30
Modified: 2019-05-18 11:30
Category: blogTags: principal, otros
Slug: hola-mundo
Authors: Rafnix Guzmán
Summary: Mi primer post usando Pelican y GitHub Pages

Acá pueden empezar a escribir todo lo que quieran pueden agregar todas las sintaxis de *Markdown* que deseen.
## Título
### Subtítulo
Este es un ejemplo de texto que da entrada a una lista genérica de elementos:
- Elemento 1
- Elemento 2
- Elemento 3

Este es un ejemplo de texto que da entrada a una lista numerada:
1. Elemento 1
2. Elemento 2
3. Elemento 3

Al texto en Markdown puedes añadirle formato como **negrita** o *cursiva* de una manera muy sencilla.
Todo esto fue extraído de este [Post sobre markdown](https://markdown.es/sintaxis-markdown/)

Probando nuestro blog en local

Luego de escribir y guardar su primer post, procedemos a generar un servidor de pruebas para ver nuestro resultado antes de subir nuestra web a GitHub, estando en la raíz de nuestro proyecto ejecutamos el siguiente comando.

$ make devserver pelican -lr /home/username/blog/pelican/content -o /home/username/blog/pelican/output -s /home/username/blog/pelican/pelicanconf.py 

-> Modified: content, theme, settings. re-generating... 
Done: Processed 1 article, 0 drafts, 0 pages, 0 hidden pages and 0 draft pages in 0.15 seconds.

Para entrar a nuestro servidor local de pruebas debemos ingresar a la siguiente URL http://localhost:8000 con nuestro explorador favorito(espero no se IE, xD)

Subir nuestro blog a GitHub Pages

Ya con esto procederemos a preparar todo para subirlo a github, este primer comando sube nuestro código fuente.

$ git add -A && git commit -a -m 'post hola-mundo.md' && git push --all

Ahora subimos todo a la rama master, recuerdan que les dije que no se preocuparan por esto, es debido a que este comando hace toda esta preparación de subir todo lo que se encuentra en la carpeta output a nuestra rama master

$ make github

Acá se les preguntaran sus credenciales de github, para poder subir a su repositorio todo el sitio estático ya generado, con esto su blog estará funcionando en https://su_username.github.io/

Para el próximo post veremos cómo configurar un Thema y algunos Plugins para potenciar el funcionamiento de Pelican, además de unas configuraciones extra que nos ayudaran a tener mejor SEO.

Nos vemos en el próximo post, muchas gracias por leerme y cualquier duda, comentario, o lo que sea, lo pueden dejar por aca o por mi cuenta de Twitter @rafnixg.

Forem: Rafnix Guzmán

⚙️ Como automatizar tu librería en PyPI con GitHub Actions

Qu es GitHub Actions?

📦 Automatizando la publicacin en PyPI con GitHub Actions

Requisitos previos

🔐 Agregar tu token de PyPI como secret en GitHub

📁 Estructura de archivos

🚀 Configurando el workflow

🎯Activando el workflow al publicar un release

🛡Definir permisos mnimos necesarios

🛠Crear el job y configurar el entorno

📋Agregar los pasos del workflow

📂 Clonando el repositorio

🐍 Configurar el entorno de Python

📥 Instalando las dependencias necesarias

🏗Construir el paquete

📤Publicar el paquete en PyPI

📄 Archivo completo del workflow (python-publish.yml)

💾 Subiendo los cambios al repositorio

🏷 Crear una nueva release en GitHub

Verificar el resultado de la publicacin

🧠 Conclusin

🔍Referencias

🔗 Documentacin oficial GitHub Actions

🔗 Documentacin oficial PyPI usando GitHub Actions

🔗 Documentacion del GitHub Actions PyPI Publish

🏗️ Cómo publicar tu propia librería de Python: Guía paso a paso

🧭 Introduccin y primeros pasos

🏗 Crear la base de tu librera en Python

🧪Preparacin del entorno de desarrollo

📁 Estructura del proyecto

🧾 Crear el archivo principal src/rafnixg/rafnixg.py

🧩 Inicializar el paquete con src/rafnixg/__init__.py

🧩 Ejecutar como modulo con src/rafnixg/__main__.py

🖥 Ejecutar y probar tu cdigo localmente

📦 Preparar la librera para ser publicada

📘Documentando nuestra librera

🗂 Organizar el archivo pyproject.toml

🔢 Usar versionamiento semntico

📜 Elegir una licencia adecuada

📥 Instalar tu librera localmente

🚀 Publica tu librera a PyPI

🧑💻 Crear cuentas en PyPI y TestPyPI

🔐 Generar una API Key

🛠 Construir el paquete con build

Verificar el paquete con twine check

Subir el paquete a PyPI

📥 Instalar tu paquete desde PyPI

🧠 Conclusiones

Shell de Odoo: Domina Operaciones Avanzadas, Integración de Librerías y Automatización de Tareas

Acceso avanzado a la shell de Odoo

Uso de diferentes archivos de configuracin

Acceso remoto a la shell de Odoo

Operaciones avanzadas en la shell de Odoo

Actualizacin de mdulos desde la shell

Importacin y exportacin de datos en formatos CSV

Trabajo con registros y campos relacionales

Bsqueda y manipulacin de registros con filtros y operadores avanzados

Uso de contextos

Integracin de libreras externas en la shell de Odoo

Uso de Pandas para el anlisis y tratamiento de datos

Otras libreras tiles para mejorar el trabajo en la shell

Automatizacin de tareas con la shell de Odoo

Ejecucin de scripts y comandos desde archivos externos

Programacin de tareas automatizadas y cron jobs desde la shell

Seguridad y buenas prcticas en el uso de la shell de Odoo

Recomendaciones para proteger la informacin y evitar accesos no autorizados

Uso responsable de la shell en entornos de produccin

Conclusin

Explorando Odoo a fondo: Cómo trabajar con la shell de la CLI y configurar IPython como REPL

Cmo ejecutar una shell usando la CLI de Odoo

Cmo configurar la interfaz de la shell para usar IPython como REPL

Recomendaciones para el uso de la shell de Odoo

Configuracin separada para la shell de Odoo

Uso de libreras externas

Conclusin

Crea tu propio chatbot con la API de OpenAI y Gradio en Python

Introduccin

Conectando a la API de OpenAI

Instalacin de dependencias

📄 Archivo completo del workflow (`python-publish.yml`)

🧩 Inicializar el paquete con src/rafnixg/init.py

🧩 Ejecutar como modulo con src/rafnixg/main.py

🗂 Organizar el archivo `pyproject.toml`

🛠 Construir el paquete con `build`

Verificar el paquete con `twine check`