chore: track all project map and index files
Add generated .pi-map.md and .pi-map.index.md files across the repository so the project navigation maps are shared and versioned. These artifacts are maintained by project_map_init/patch/validate and must be kept in sync with source edits. Note: .cache/ remains ignored (added in previous commit).
This commit is contained in:
Developer
@@ -0,0 +1,37 @@
|
||||
# apps/api/src/models (index)
|
||||
dir: apps/api/src/models
|
||||
|
||||
## role
|
||||
Provides the core database model layer with a centralized public API, defining SQLAlchemy base classes and reusable mixins for consistent schema patterns across the API application.
|
||||
## parent
|
||||
index: apps/api/src/.pi-map.index.md
|
||||
map: apps/api/src/.pi-map.md
|
||||
## children
|
||||
- apps/api/src/models/config
|
||||
index: apps/api/src/models/config/.pi-map.index.md
|
||||
map: apps/api/src/models/config/.pi-map.md
|
||||
- apps/api/src/models/project
|
||||
index: apps/api/src/models/project/.pi-map.index.md
|
||||
map: apps/api/src/models/project/.pi-map.md
|
||||
- apps/api/src/models/system
|
||||
index: apps/api/src/models/system/.pi-map.index.md
|
||||
map: apps/api/src/models/system/.pi-map.md
|
||||
- apps/api/src/models/tool
|
||||
index: apps/api/src/models/tool/.pi-map.index.md
|
||||
map: apps/api/src/models/tool/.pi-map.md
|
||||
- apps/api/src/models/user
|
||||
index: apps/api/src/models/user/.pi-map.index.md
|
||||
map: apps/api/src/models/user/.pi-map.md
|
||||
## files
|
||||
- __init__.py
|
||||
- base.py
|
||||
## links
|
||||
index: apps/api/src/models/.pi-map.index.md
|
||||
map: apps/api/src/models/.pi-map.md
|
||||
## workflows
|
||||
- change models behavior
|
||||
read: __init__.py, base.py
|
||||
- explore models subdirectories
|
||||
index: apps/api/src/models/config/.pi-map.index.md, apps/api/src/models/project/.pi-map.index.md, apps/api/src/models/system/.pi-map.index.md
|
||||
## dirty
|
||||
-
|
||||
@@ -0,0 +1,25 @@
|
||||
# apps/api/src/models
|
||||
dir: apps/api/src/models
|
||||
|
||||
index: apps/api/src/models/.pi-map.index.md
|
||||
|
||||
## role
|
||||
Provides the core database model layer with a centralized public API, defining SQLAlchemy base classes and reusable mixins for consistent schema patterns across the API application.
|
||||
## files
|
||||
- __init__.py | Re-exports model classes from submodules to provide a centralized public API for the src.models package | dep: src.models.base, src.models.config.config_profile, src.models.project.git_repository, src.models.project.project, src.models.project.workspace, src.models.system.health_check, src.models.system.instance_event, src.models.system.notification, src.models.system.terminal_session, src.models.tool.tool_definition_manifest, src.models.tool.tool_instance, src.models.tool.tool_type, src.models.user.ssh_key, src.models.user.user, src.models.user.user_config
|
||||
- base.py | Defines SQLAlchemy base model and reusable mixins for UUID primary keys and automatic timestamp tracking in database models. | exp: class:Base, class:UUIDPrimaryKeyMixin, class:TimestampMixin | dep: uuid, datetime, sqlalchemy, sqlalchemy.orm
|
||||
## arch
|
||||
Uses the declarative base pattern with mixin composition for cross-cutting concerns (UUIDs, timestamps), and a facade/aggregate module pattern via __init__.py re-exports to simplify imports for consumers.
|
||||
## tags
|
||||
models, src, base, project, system, user, mixin, tool
|
||||
## symbols
|
||||
- Base
|
||||
- UUIDPrimaryKeyMixin
|
||||
- TimestampMixin
|
||||
## workflows
|
||||
- change models behavior
|
||||
read: __init__.py, base.py
|
||||
- explore models subdirectories
|
||||
index: apps/api/src/models/config/.pi-map.index.md, apps/api/src/models/project/.pi-map.index.md, apps/api/src/models/system/.pi-map.index.md
|
||||
## dirty
|
||||
-
|
||||
@@ -0,0 +1,23 @@
|
||||
# apps/api/src/models/config (index)
|
||||
dir: apps/api/src/models/config
|
||||
|
||||
## role
|
||||
Provides SQLAlchemy ORM models for managing configuration profiles and their hierarchical includes in the API application.
|
||||
## parent
|
||||
index: apps/api/src/models/.pi-map.index.md
|
||||
map: apps/api/src/models/.pi-map.md
|
||||
## children
|
||||
-
|
||||
## files
|
||||
- __init__.py
|
||||
- config_profile.py
|
||||
## links
|
||||
index: apps/api/src/models/config/.pi-map.index.md
|
||||
map: apps/api/src/models/config/.pi-map.md
|
||||
## workflows
|
||||
- change config behavior
|
||||
read: __init__.py, config_profile.py
|
||||
- change config config
|
||||
read: config_profile.py
|
||||
## dirty
|
||||
-
|
||||
@@ -0,0 +1,24 @@
|
||||
# apps/api/src/models/config
|
||||
dir: apps/api/src/models/config
|
||||
|
||||
index: apps/api/src/models/config/.pi-map.index.md
|
||||
|
||||
## role
|
||||
Provides SQLAlchemy ORM models for managing configuration profiles and their hierarchical includes in the API application.
|
||||
## files
|
||||
- __init__.py | Exports config model classes from a subpackage for simplified importing | dep: src.models.config.config_profile
|
||||
- config_profile.py | Defines SQLAlchemy ORM models for configuration profiles and their includes, storing environment variables, runtime hints, mounts, files, and git mounts with user/project/tool associations and self-referential inclusion relationships. | exp: class:ConfigProfile, class:ConfigProfileInclude | dep: uuid, typing, sqlalchemy, sqlalchemy.orm, src.models.base, src.models.project, src.models, src.models.user, src.models (ToolType)
|
||||
## arch
|
||||
Uses SQLAlchemy declarative ORM pattern with self-referential many-to-many relationships for profile inclusion, and associations to users, projects, and tools.
|
||||
## tags
|
||||
config, src, models, profile, sqlalchemy, init, orm, mounts
|
||||
## symbols
|
||||
- ConfigProfile
|
||||
- ConfigProfileInclude
|
||||
## workflows
|
||||
- change config behavior
|
||||
read: __init__.py, config_profile.py
|
||||
- change config config
|
||||
read: config_profile.py
|
||||
## dirty
|
||||
-
|
||||
@@ -0,0 +1,23 @@
|
||||
# apps/api/src/models/project (index)
|
||||
dir: apps/api/src/models/project
|
||||
|
||||
## role
|
||||
Defines the core data models for project-related entities (GitRepository, Project, Workspace) using SQLAlchemy ORM.
|
||||
## parent
|
||||
index: apps/api/src/models/.pi-map.index.md
|
||||
map: apps/api/src/models/.pi-map.md
|
||||
## children
|
||||
-
|
||||
## files
|
||||
- __init__.py
|
||||
- git_repository.py
|
||||
- project.py
|
||||
- workspace.py
|
||||
## links
|
||||
index: apps/api/src/models/project/.pi-map.index.md
|
||||
map: apps/api/src/models/project/.pi-map.md
|
||||
## workflows
|
||||
- change project behavior
|
||||
read: __init__.py, git_repository.py, project.py
|
||||
## dirty
|
||||
-
|
||||
@@ -0,0 +1,25 @@
|
||||
# apps/api/src/models/project
|
||||
dir: apps/api/src/models/project
|
||||
|
||||
index: apps/api/src/models/project/.pi-map.index.md
|
||||
|
||||
## role
|
||||
Defines the core data models for project-related entities (GitRepository, Project, Workspace) using SQLAlchemy ORM.
|
||||
## files
|
||||
- __init__.py | Exports the three main project model classes (GitRepository, Project, Workspace) as the public API for the models.project package. | dep: src.models.project.git_repository, src.models.project.project, src.models.project.workspace
|
||||
- git_repository.py | Defines a SQLAlchemy ORM model for Git repositories with relationships to projects, users, and SSH keys. | exp: class:GitRepository | dep: uuid, datetime, typing, sqlalchemy, sqlalchemy.orm, src.models.base, src.models.project, src.models, src.models.user, src.models.ssh_key
|
||||
- project.py | Defines a SQLAlchemy ORM model for a Project entity with relationships to users, Git repositories, and SSH keys. | exp: class:Project | dep: uuid, typing, sqlalchemy, sqlalchemy.orm, src.models.base, src.models, src.models.user, src.models.GitRepository, src.models.SSHKey, src.models.user.User
|
||||
- workspace.py | Defines a SQLAlchemy ORM model for persistent writable Git repository clones associated with users. | exp: class:Workspace | dep: uuid, datetime, typing, sqlalchemy, sqlalchemy.orm, src.models.base, src.models, src.models.user, src.models.GitRepository, src.models.user.User
|
||||
## arch
|
||||
Standard SQLAlchemy ORM pattern with declarative models, package-level public API abstraction via __init__.py, and bidirectional relationships between entities.
|
||||
## tags
|
||||
models, src, project, sqlalchemy, git, user, workspace, orm
|
||||
## symbols
|
||||
- GitRepository
|
||||
- Project
|
||||
- Workspace
|
||||
## workflows
|
||||
- change project behavior
|
||||
read: __init__.py, git_repository.py, project.py
|
||||
## dirty
|
||||
-
|
||||
@@ -0,0 +1,24 @@
|
||||
# apps/api/src/models/system (index)
|
||||
dir: apps/api/src/models/system
|
||||
|
||||
## role
|
||||
Provides SQLAlchemy ORM models for system-level operational and audit data including health checks, instance events, notifications, and terminal sessions.
|
||||
## parent
|
||||
index: apps/api/src/models/.pi-map.index.md
|
||||
map: apps/api/src/models/.pi-map.md
|
||||
## children
|
||||
-
|
||||
## files
|
||||
- __init__.py
|
||||
- health_check.py
|
||||
- instance_event.py
|
||||
- notification.py
|
||||
- terminal_session.py
|
||||
## links
|
||||
index: apps/api/src/models/system/.pi-map.index.md
|
||||
map: apps/api/src/models/system/.pi-map.md
|
||||
## workflows
|
||||
- change system behavior
|
||||
read: __init__.py, health_check.py, instance_event.py
|
||||
## dirty
|
||||
-
|
||||
@@ -0,0 +1,27 @@
|
||||
# apps/api/src/models/system
|
||||
dir: apps/api/src/models/system
|
||||
|
||||
index: apps/api/src/models/system/.pi-map.index.md
|
||||
|
||||
## role
|
||||
Provides SQLAlchemy ORM models for system-level operational and audit data including health checks, instance events, notifications, and terminal sessions.
|
||||
## files
|
||||
- __init__.py | Exports system-related model classes from a package for convenient importing. | dep: src.models.system.health_check, src.models.system.instance_event, src.models.system.notification, src.models.system.terminal_session
|
||||
- health_check.py | Defines a SQLAlchemy ORM model for storing health check snapshots of tool instances with various status and probe fields. | exp: class:HealthCheck | dep: uuid, datetime, sqlalchemy, sqlalchemy.orm, src.models.base
|
||||
- instance_event.py | Defines a SQLAlchemy ORM model for auditing instance lifecycle events with metadata, status tracking, and user attribution. | exp: class:InstanceEvent | dep: uuid, datetime, typing, sqlalchemy, sqlalchemy.orm, src.models.base
|
||||
- notification.py | Defines a SQLAlchemy ORM model for storing user notifications with metadata, read/dismissed tracking, and polymorphic source references. | exp: class:Notification | dep: datetime, typing, uuid, sqlalchemy, sqlalchemy.orm, sqlalchemy.sql, src.models.base
|
||||
- terminal_session.py | Defines a SQLAlchemy database model for storing terminal session metadata with lifecycle tracking. | exp: class:TerminalSessionModel | dep: uuid, datetime, sqlalchemy, sqlalchemy.orm, src.models.base
|
||||
## arch
|
||||
Standard SQLAlchemy declarative ORM pattern with timestamped base models, polymorphic relationships (notification sources), lifecycle state tracking, and audit fields (user attribution, status enums).
|
||||
## tags
|
||||
sqlalchemy, src, models, model, orm, system, notification, health
|
||||
## symbols
|
||||
- HealthCheck
|
||||
- InstanceEvent
|
||||
- Notification
|
||||
- TerminalSessionModel
|
||||
## workflows
|
||||
- change system behavior
|
||||
read: __init__.py, health_check.py, instance_event.py
|
||||
## dirty
|
||||
-
|
||||
@@ -0,0 +1,23 @@
|
||||
# apps/api/src/models/tool (index)
|
||||
dir: apps/api/src/models/tool
|
||||
|
||||
## role
|
||||
Defines SQLAlchemy ORM models for managing tool definitions, instances, and types in a container-based deployment system.
|
||||
## parent
|
||||
index: apps/api/src/models/.pi-map.index.md
|
||||
map: apps/api/src/models/.pi-map.md
|
||||
## children
|
||||
-
|
||||
## files
|
||||
- __init__.py
|
||||
- tool_definition_manifest.py
|
||||
- tool_instance.py
|
||||
- tool_type.py
|
||||
## links
|
||||
index: apps/api/src/models/tool/.pi-map.index.md
|
||||
map: apps/api/src/models/tool/.pi-map.md
|
||||
## workflows
|
||||
- change tool behavior
|
||||
read: __init__.py, tool_definition_manifest.py, tool_instance.py
|
||||
## dirty
|
||||
-
|
||||
@@ -0,0 +1,25 @@
|
||||
# apps/api/src/models/tool
|
||||
dir: apps/api/src/models/tool
|
||||
|
||||
index: apps/api/src/models/tool/.pi-map.index.md
|
||||
|
||||
## role
|
||||
Defines SQLAlchemy ORM models for managing tool definitions, instances, and types in a container-based deployment system.
|
||||
## files
|
||||
- __init__.py | Exports the public API for the tool models module by re-exporting three key classes. | dep: src.models.tool.tool_definition_manifest, src.models.tool.tool_instance, src.models.tool.tool_type
|
||||
- tool_definition_manifest.py | Defines a SQLAlchemy ORM model for storing tool definition manifests that compile to Dockerfiles and Compose files, supporting both base definitions and tool-specific definitions with inheritance. | exp: class:ToolDefinitionManifest | dep: uuid, typing, sqlalchemy, sqlalchemy.orm, src.models.base, src.models.user
|
||||
- tool_instance.py | Defines a SQLAlchemy ORM model for tool instances that represent deployed tools with container/runtime metadata and relationships to users, projects, repositories, and workspaces. | exp: class:ToolInstance | dep: uuid, datetime, typing, sqlalchemy, sqlalchemy.orm, src.models.base, src.models, src.models.project, src.models.user, src.models (ConfigProfile, GitRepository, Project, ToolType, User, Workspace)
|
||||
- tool_type.py | Defines a SQLAlchemy ORM model for tool types that represent configurable categories of tools with deployment templates, manifest references, and metadata. | exp: class:ToolType | dep: uuid, typing, sqlalchemy, sqlalchemy.orm, src.models.base, src.models.tool.tool_definition_manifest, src.models.user
|
||||
## arch
|
||||
Domain-driven SQLAlchemy ORM models with inheritance patterns (base/tool-specific manifests), rich relationships (users, projects, repositories, workspaces), and template-based deployment abstractions.
|
||||
## tags
|
||||
tool, models, src, sqlalchemy, orm, definition, manifest, base
|
||||
## symbols
|
||||
- ToolDefinitionManifest
|
||||
- ToolInstance
|
||||
- ToolType
|
||||
## workflows
|
||||
- change tool behavior
|
||||
read: __init__.py, tool_definition_manifest.py, tool_instance.py
|
||||
## dirty
|
||||
-
|
||||
@@ -0,0 +1,25 @@
|
||||
# apps/api/src/models/user (index)
|
||||
dir: apps/api/src/models/user
|
||||
|
||||
## role
|
||||
Provides the core data models for user identity, authentication credentials, and personal configuration in the API's database layer.
|
||||
## parent
|
||||
index: apps/api/src/models/.pi-map.index.md
|
||||
map: apps/api/src/models/.pi-map.md
|
||||
## children
|
||||
-
|
||||
## files
|
||||
- __init__.py
|
||||
- ssh_key.py
|
||||
- user.py
|
||||
- user_config.py
|
||||
## links
|
||||
index: apps/api/src/models/user/.pi-map.index.md
|
||||
map: apps/api/src/models/user/.pi-map.md
|
||||
## workflows
|
||||
- change user behavior
|
||||
read: __init__.py, ssh_key.py, user.py
|
||||
- change user config
|
||||
read: user_config.py
|
||||
## dirty
|
||||
-
|
||||
@@ -0,0 +1,27 @@
|
||||
# apps/api/src/models/user
|
||||
dir: apps/api/src/models/user
|
||||
|
||||
index: apps/api/src/models/user/.pi-map.index.md
|
||||
|
||||
## role
|
||||
Provides the core data models for user identity, authentication credentials, and personal configuration in the API's database layer.
|
||||
## files
|
||||
- __init__.py | Exports the user-related model classes (SSHKey, User, UserConfig) from a package for convenient importing. | dep: src.models.user.ssh_key, src.models.user.user, src.models.user.user_config
|
||||
- ssh_key.py | Defines an SSHKey SQLAlchemy ORM model for storing encrypted SSH key pairs with user and optional project associations. | exp: class:SSHKey | dep: uuid, typing, sqlalchemy, sqlalchemy.orm, src.models.base, src.models.project, src.models.user
|
||||
- user.py | Defines a SQLAlchemy ORM model for a User entity with authentication fields and relationships to projects, SSH keys, and user configuration. | exp: class:User | dep: typing, sqlalchemy, sqlalchemy.orm, src.models.base, src.models.project, src.models, src.models.SSHKey, src.models.UserConfig
|
||||
- user_config.py | Defines a SQLAlchemy model for storing per-user JSON configuration with typed property accessors for default profile IDs. | exp: class:UserConfig | dep: uuid, typing, sqlalchemy, sqlalchemy.orm, src.models.base, src.models.user
|
||||
## arch
|
||||
Follows SQLAlchemy ORM declarative model pattern with package-level aggregation via __init__.py, using explicit table relationships (foreign keys, one-to-many associations) and a JSON-backed configuration store with typed property accessors.
|
||||
## tags
|
||||
user, src, models, sqlalchemy, sshkey, orm, model, ssh
|
||||
## symbols
|
||||
- SSHKey
|
||||
- User
|
||||
- UserConfig
|
||||
## workflows
|
||||
- change user behavior
|
||||
read: __init__.py, ssh_key.py, user.py
|
||||
- change user config
|
||||
read: user_config.py
|
||||
## dirty
|
||||
-
|
||||
Reference in New Issue
Block a user