Comandos y herramientas

Los comandos listados a continuación están definidos en el archivo justfile.

Nota

Recomendamos leer la documentación de Just para más información.

set dotenv-load := false

[doc('show justfile config file')]
help:
    @echo "Tasks for Callisto"
    @echo "run 'just -l' to show all recipes"
    @echo

[doc('start server')]
serve:
    uv run uvicorn main:fastapp --reload --port 6969

[doc('format code using Ruff')]
fmt:
    uv run ruff format main.py app/ tools/

[doc('sort imports using Ruff')]
sort:
    uv run ruff check --select I --fix .

Para tener en cuenta

el archivo justfile tiene muchas tareas , te recomendamos leer la documentación de Just y revisar el archivo justfile para mejor comodidad.

Iniciar el servidor web

1	`$ just serve`

Organizar y formatear el código fuente

1	`$ just fix`

Las reglas para Ruff están definidas en el archivo .ruff.toml, ubicado en carpeta raíz del proyecto.

Revisar errores (lint)

Para tener en cuenta

Este comando utiliza internamente a ruff, Un linter para Python extremadamente rápido, escrito en Rust. Se recomienda realizar un commit y guardar todos los cambios, antes de realizar esta operación.

1	`$ just lint`

Corregir automáticamente (si es posible).

1	`$ just lint-fix`

las reglas para ruff están definidas en el archivo .ruff.toml, ubicado en la raiz del proyecto.

Crear un CRUD básico

1	`$ just crud`

lee el apartado de Crear un CRUD básico para más información.

Generar un archivo requirements.txt

Este comando incluye todas las dependencias del proyecto, incluyendo herramientas de desarrollo, documentación y pruebas. revisa el apartado de dependencies y project.optional-dependencies, en el archivo pyproject.toml.

Importante

El comando citado a continuación, creará un archivo llamado requirements-dev.txt.

$ just export

Si no desea incluir todas las dependencias

Importante

El comando citado a continuación, creará un archivo llamado requirements.txt.

1	`$ just export-req`

revisa la sección [tool.callisto] en el archivo pyproject.toml, para definir configuraciones adicionales.

Construir la documentación

Organizar todo el apartado de referencias del código fuente.

1	`$ just docs-gen`

Construir este sitio

$ just docs-build 

el sitio construido se encontrará en la capeta dist/site.

Ejecutar las pruebas

1	`$ just test-all`

lee el apartado de Pruebas para más información.

Ejecutar un chequeo de seguridad

Bandit es una herramienta diseñada para encontrar problemas de seguridad comunes en el código Python.

1	`$ just check-sec`