Fix code issues and add missing documentation

- Fix duplicate tenant_id parameter in seed.py (line 148)
- Add security warning to SECRET_KEY in .env.example
- Create comprehensive README.md with setup instructions
- Add Alembic configuration files (alembic.ini, env.py, script.py.mako)
- Create initial database migration for all tables
- Document project structure, features, and deployment checklist
This commit is contained in:
drjones
2026-07-06 02:58:08 +00:00
parent 463dff883b
commit 631a6b4147
7 changed files with 651 additions and 1 deletions

View File

@@ -0,0 +1,187 @@
"""Initial migration - create all tables
Revision ID: 001
Revises:
Create Date: 2025-01-01 00:00:00.000000
"""
from typing import Sequence, Union
from alembic import op
import sqlalchemy as sa
from sqlalchemy.dialects import postgresql
# revision identifiers, used by Alembic.
revision: str = '001'
down_revision: Union[str, None] = None
branch_labels: Union[str, Sequence[str], None] = None
depends_on: Union[str, Sequence[str], None] = None
def upgrade() -> None:
# Create tenants table
op.create_table(
'tenants',
sa.Column('id', sa.String(36), primary_key=True),
sa.Column('name', sa.String(255), nullable=False),
sa.Column('slug', sa.String(100), unique=True, nullable=False),
sa.Column('industry', sa.String(100), nullable=True),
sa.Column('size_range', sa.String(50), nullable=True),
sa.Column('contact_email', sa.String(255), nullable=True),
sa.Column('is_active', sa.Boolean(), default=True),
sa.Column('created_at', sa.DateTime(), nullable=False),
sa.Column('updated_at', sa.DateTime(), nullable=False),
)
# Create users table
op.create_table(
'users',
sa.Column('id', sa.String(36), primary_key=True),
sa.Column('tenant_id', sa.String(36), sa.ForeignKey('tenants.id'), nullable=False),
sa.Column('email', sa.String(255), unique=True, nullable=False),
sa.Column('hashed_password', sa.String(255), nullable=False),
sa.Column('full_name', sa.String(255), nullable=False),
sa.Column('role', sa.String(50), nullable=False),
sa.Column('is_active', sa.Boolean(), default=True),
sa.Column('created_at', sa.DateTime(), nullable=False),
sa.Column('last_login', sa.DateTime(), nullable=True),
)
# Create authorized_assets table
op.create_table(
'authorized_assets',
sa.Column('id', sa.String(36), primary_key=True),
sa.Column('tenant_id', sa.String(36), sa.ForeignKey('tenants.id'), nullable=False),
sa.Column('value', sa.String(500), nullable=False),
sa.Column('asset_type', sa.String(50), nullable=False),
sa.Column('description', sa.Text(), nullable=True),
sa.Column('scope_agreement_ref', sa.String(255), nullable=True),
sa.Column('authorized_by', sa.String(255), nullable=True),
sa.Column('authorized_at', sa.DateTime(), nullable=False),
sa.Column('is_active', sa.Boolean(), default=True),
)
# Create assets table
op.create_table(
'assets',
sa.Column('id', sa.String(36), primary_key=True),
sa.Column('tenant_id', sa.String(36), sa.ForeignKey('tenants.id'), nullable=False),
sa.Column('name', sa.String(500), nullable=False),
sa.Column('asset_type', sa.String(50), nullable=False),
sa.Column('value', sa.String(500), nullable=False),
sa.Column('owner_name', sa.String(255), nullable=True),
sa.Column('owner_email', sa.String(255), nullable=True),
sa.Column('tags', sa.Text(), nullable=True),
sa.Column('notes', sa.Text(), nullable=True),
sa.Column('is_active', sa.Boolean(), default=True),
sa.Column('first_seen', sa.DateTime(), nullable=False),
sa.Column('last_seen', sa.DateTime(), nullable=False),
)
# Create executives table
op.create_table(
'executives',
sa.Column('id', sa.String(36), primary_key=True),
sa.Column('tenant_id', sa.String(36), sa.ForeignKey('tenants.id'), nullable=False),
sa.Column('full_name', sa.String(255), nullable=False),
sa.Column('title', sa.String(255), nullable=True),
sa.Column('corporate_email', sa.String(255), nullable=True),
sa.Column('is_enrolled', sa.Boolean(), default=True),
sa.Column('notes', sa.Text(), nullable=True),
sa.Column('created_at', sa.DateTime(), nullable=False),
)
# Create findings table
op.create_table(
'findings',
sa.Column('id', sa.String(36), primary_key=True),
sa.Column('tenant_id', sa.String(36), sa.ForeignKey('tenants.id'), nullable=False),
sa.Column('asset_id', sa.String(36), sa.ForeignKey('assets.id'), nullable=True),
sa.Column('executive_id', sa.String(36), sa.ForeignKey('executives.id'), nullable=True),
sa.Column('title', sa.String(500), nullable=False),
sa.Column('severity', sa.String(50), nullable=False),
sa.Column('status', sa.String(50), nullable=False),
sa.Column('category', sa.String(50), nullable=False),
sa.Column('technical_description', sa.Text(), nullable=True),
sa.Column('cve_id', sa.String(30), nullable=True),
sa.Column('cvss_score', sa.Float(), nullable=True),
sa.Column('affected_component', sa.String(500), nullable=True),
sa.Column('evidence', sa.Text(), nullable=True),
sa.Column('ai_summary', sa.Text(), nullable=True),
sa.Column('ai_business_impact', sa.Text(), nullable=True),
sa.Column('ai_impact_level', sa.String(20), nullable=True),
sa.Column('ai_remediation_steps', sa.Text(), nullable=True),
sa.Column('ai_fix_priority', sa.String(20), nullable=True),
sa.Column('ai_generated_at', sa.DateTime(), nullable=True),
sa.Column('assignee_email', sa.String(255), nullable=True),
sa.Column('due_date', sa.DateTime(), nullable=True),
sa.Column('resolution_note', sa.Text(), nullable=True),
sa.Column('resolved_at', sa.DateTime(), nullable=True),
sa.Column('verified_at', sa.DateTime(), nullable=True),
sa.Column('source', sa.String(100), nullable=True),
sa.Column('is_top_risk', sa.Boolean(), default=False),
sa.Column('created_at', sa.DateTime(), nullable=False),
sa.Column('updated_at', sa.DateTime(), nullable=False),
)
# Create risk_scores table
op.create_table(
'risk_scores',
sa.Column('id', sa.String(36), primary_key=True),
sa.Column('tenant_id', sa.String(36), sa.ForeignKey('tenants.id'), nullable=False),
sa.Column('score_date', sa.DateTime(), nullable=False),
sa.Column('overall_score', sa.Float(), nullable=False),
sa.Column('score_identity', sa.Float(), nullable=True),
sa.Column('score_cloud', sa.Float(), nullable=True),
sa.Column('score_network', sa.Float(), nullable=True),
sa.Column('score_web', sa.Float(), nullable=True),
sa.Column('score_credential', sa.Float(), nullable=True),
sa.Column('score_digital_footprint', sa.Float(), nullable=True),
sa.Column('score_third_party', sa.Float(), nullable=True),
sa.Column('critical_count', sa.Integer(), default=0),
sa.Column('high_count', sa.Integer(), default=0),
sa.Column('medium_count', sa.Integer(), default=0),
sa.Column('low_count', sa.Integer(), default=0),
sa.Column('notes', sa.Text(), nullable=True),
)
# Create attack_paths table
op.create_table(
'attack_paths',
sa.Column('id', sa.String(36), primary_key=True),
sa.Column('finding_id', sa.String(36), sa.ForeignKey('findings.id'), nullable=False),
sa.Column('title', sa.String(500), nullable=False),
sa.Column('ai_narrative', sa.Text(), nullable=True),
sa.Column('nodes_json', sa.Text(), nullable=True),
sa.Column('edges_json', sa.Text(), nullable=True),
sa.Column('created_at', sa.DateTime(), nullable=False),
)
# Create audit_reports table
op.create_table(
'audit_reports',
sa.Column('id', sa.String(36), primary_key=True),
sa.Column('tenant_id', sa.String(36), sa.ForeignKey('tenants.id'), nullable=False),
sa.Column('title', sa.String(500), nullable=False),
sa.Column('report_date', sa.DateTime(), nullable=False),
sa.Column('baseline_score', sa.Float(), nullable=True),
sa.Column('executive_summary', sa.Text(), nullable=True),
sa.Column('scope_description', sa.Text(), nullable=True),
sa.Column('key_findings_json', sa.Text(), nullable=True),
sa.Column('pdf_path', sa.String(500), nullable=True),
sa.Column('is_baseline', sa.Boolean(), default=True),
sa.Column('generated_by', sa.String(255), nullable=True),
sa.Column('created_at', sa.DateTime(), nullable=False),
)
def downgrade() -> None:
op.drop_table('audit_reports')
op.drop_table('attack_paths')
op.drop_table('risk_scores')
op.drop_table('findings')
op.drop_table('executives')
op.drop_table('assets')
op.drop_table('authorized_assets')
op.drop_table('users')
op.drop_table('tenants')