2c7edba693
Nueva regla projects.md que documenta como agrupar apps, analyses y vaults bajo
un tema comun en projects/{nombre}/. Actualiza INDEX.md con la entrada #15.
Crea directorios projects/ y vaults/ con .gitkeep (contenido real gitignored).
registry.db regenerado con los cambios del indice.
3.3 KiB
3.3 KiB
Projects: apps, analysis y vaults bajo un tema comun
Un project agrupa apps, analyses y vaults relacionados. Vive en projects/{nombre}/ con esta estructura:
projects/{nombre}/
project.md # Frontmatter obligatorio (name, description, tags)
apps/ # Apps del proyecto (cada una con app.md)
{app_name}/
app.md
...
analysis/ # Analyses del proyecto (cada uno con analysis.md)
{analysis_name}/
analysis.md
.venv/
notebooks/
run-jupyter-lab.sh
...
vaults/ # Datos del proyecto
vault.yaml # Manifest de vaults (nombre, descripcion, path, tags)
{vault_name} -> /abs/path # Symlinks a directorios reales de datos
Reglas
project.mdsigue el template dedocs/templates/project.md— campos:name,description,tags,repo_urlanalysis.mdsigue el template dedocs/templates/analysis.md—dir_pathdebe apuntar aprojects/{nombre}/analysis/{tema}/vault.yamllista los vaults con nombre, descripcion, path absoluto y tags- Los vaults reales viven fuera del repo (ej:
~/vaults/{nombre}/) con symlinks en el proyecto fn indexescaneaprojects/*/y seteaproject_idautomaticamente en apps, analyses y vaults- Apps y analyses sueltos (sin proyecto) siguen en
apps/yanalysis/en la raiz
Raiz vs proyecto
| Ubicacion | Para que |
|---|---|
apps/ |
Apps independientes que no pertenecen a ningun proyecto |
analysis/ |
Analyses independientes |
projects/{nombre}/apps/ |
Apps de un proyecto — project_id se setea automaticamente |
projects/{nombre}/analysis/ |
Analyses de un proyecto — project_id se setea automaticamente |
Crear un proyecto nuevo
# 1. Crear estructura
mkdir -p projects/{nombre}/{apps,analysis,vaults}
# 2. Crear project.md con frontmatter
fn add -k project # genera template
# 3. Crear vault (datos fuera del repo, symlink dentro)
mkdir -p ~/vaults/{vault_name}/{raw,processed,exports}
ln -s ~/vaults/{vault_name} projects/{nombre}/vaults/{vault_name}
# Crear vault.yaml con la entrada
# 4. Crear analysis dentro del proyecto
fn run init_jupyter_analysis {nombre_analysis} [paquetes...]
mv analysis/{nombre_analysis} projects/{nombre}/analysis/
# Crear analysis.md con dir_path correcto
# Regenerar launcher y kernel startup:
source bash/functions/infra/write_jupyter_launcher.sh && write_jupyter_launcher projects/{nombre}/analysis/{tema}
source bash/functions/infra/write_jupyter_registry_kernel.sh && write_jupyter_registry_kernel projects/{nombre}/analysis/{tema}
# 5. Indexar
fn index
fn show {nombre} # verifica el project y sus componentes
Consultas utiles
-- Listar proyectos
SELECT id, description FROM projects;
-- Analysis de un proyecto
SELECT id, name, dir_path FROM analysis WHERE project_id = 'app_turismo';
-- Vaults de un proyecto
SELECT id, name, path, symlink FROM vaults WHERE project_id = 'app_turismo';
-- Apps de un proyecto
SELECT id, name, dir_path FROM apps WHERE project_id = 'app_turismo';
-- Todo lo que pertenece a un proyecto
SELECT 'analysis' as tipo, id, name FROM analysis WHERE project_id = ?
UNION ALL
SELECT 'vault', id, name FROM vaults WHERE project_id = ?
UNION ALL
SELECT 'app', id, name FROM apps WHERE project_id = ?;