dataface 0.1.2__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- d3_format/__init__.py +14 -0
- d3_format/errors.py +19 -0
- d3_format/format.py +551 -0
- d3_format/spec.py +159 -0
- dataface/DATAFACE_SYNTAX.md +1135 -0
- dataface/__init__.py +93 -0
- dataface/_docs_site.py +20 -0
- dataface/_install_hint.py +26 -0
- dataface/agent_api/__init__.py +79 -0
- dataface/agent_api/_init_templates/__init__.py +0 -0
- dataface/agent_api/_init_templates/agents_dft_snippet.md +26 -0
- dataface/agent_api/_init_templates/dataface.yml +15 -0
- dataface/agent_api/_init_templates/faces-dataface.yml +144 -0
- dataface/agent_api/_init_templates/index.md +24 -0
- dataface/agent_api/_paths.py +118 -0
- dataface/agent_api/_project_agents_md.py +43 -0
- dataface/agent_api/_session_store.py +486 -0
- dataface/agent_api/_state.py +28 -0
- dataface/agent_api/chat.py +221 -0
- dataface/agent_api/dashboards.py +257 -0
- dataface/agent_api/describe.py +366 -0
- dataface/agent_api/describe_query.py +120 -0
- dataface/agent_api/docs/__init__.py +25 -0
- dataface/agent_api/docs/_loader.py +292 -0
- dataface/agent_api/docs/yaml-reference.md +2757 -0
- dataface/agent_api/file_refs.py +118 -0
- dataface/agent_api/init.py +126 -0
- dataface/agent_api/inspect.py +128 -0
- dataface/agent_api/mcp_install.py +170 -0
- dataface/agent_api/query.py +274 -0
- dataface/agent_api/schema.py +658 -0
- dataface/agent_api/schema_search.py +284 -0
- dataface/agent_api/search.py +270 -0
- dataface/agent_api/skill_install.py +141 -0
- dataface/agent_api/skill_render.py +90 -0
- dataface/agent_api/skills.py +293 -0
- dataface/agent_api/surface_aliases.yaml +128 -0
- dataface/agent_api/validate.py +175 -0
- dataface/agent_api/validate_query.py +84 -0
- dataface/ai/__init__.py +39 -0
- dataface/ai/agent.py +139 -0
- dataface/ai/context.py +45 -0
- dataface/ai/events.py +62 -0
- dataface/ai/external_mcp.py +610 -0
- dataface/ai/generate_sql.py +96 -0
- dataface/ai/llm.py +403 -0
- dataface/ai/mcp/__init__.py +51 -0
- dataface/ai/mcp/server.py +289 -0
- dataface/ai/memories.py +85 -0
- dataface/ai/prompts.py +177 -0
- dataface/ai/schema_context.py +138 -0
- dataface/ai/skills/before-after-comparison/SKILL.md +102 -0
- dataface/ai/skills/before-after-comparison/examples/before-after-comparison.yml +24 -0
- dataface/ai/skills/dashboard-build/SKILL.md +212 -0
- dataface/ai/skills/dashboard-build/examples/_smoke.yml +15 -0
- dataface/ai/skills/dashboard-design/SKILL.md +182 -0
- dataface/ai/skills/dashboard-review/SKILL.md +113 -0
- dataface/ai/skills/dashboard-structural-review/SKILL.md +173 -0
- dataface/ai/skills/dashboard-visual-review/SKILL.md +139 -0
- dataface/ai/skills/dataface-mcp-setup/SKILL.md +177 -0
- dataface/ai/skills/dataface-troubleshooting/SKILL.md +225 -0
- dataface/ai/skills/drill-down-link/SKILL.md +112 -0
- dataface/ai/skills/drill-down-link/examples/drill-down-link.yml +27 -0
- dataface/ai/skills/faceted-small-multiples/SKILL.md +116 -0
- dataface/ai/skills/faceted-small-multiples/examples/faceted-small-multiples.yml +33 -0
- dataface/ai/skills/filter-bar-with-variables/SKILL.md +105 -0
- dataface/ai/skills/filter-bar-with-variables/examples/filter-bar-with-variables.yml +49 -0
- dataface/ai/skills/kpi-row/SKILL.md +101 -0
- dataface/ai/skills/kpi-row/examples/kpi-row.yml +55 -0
- dataface/ai/skills/report-design/SKILL.md +184 -0
- dataface/ai/skills/single-metric-bignum/SKILL.md +90 -0
- dataface/ai/skills/single-metric-bignum/examples/single-metric-bignum.yml +27 -0
- dataface/ai/skills/table-heavy-ops-dashboard/SKILL.md +114 -0
- dataface/ai/skills/table-heavy-ops-dashboard/examples/table-heavy-ops-dashboard.yml +48 -0
- dataface/ai/skills/time-series-trend/SKILL.md +93 -0
- dataface/ai/skills/time-series-trend/examples/time-series-trend.yml +26 -0
- dataface/ai/skills/top-n-with-detail/SKILL.md +98 -0
- dataface/ai/skills/top-n-with-detail/examples/top-n-with-detail.yml +45 -0
- dataface/ai/skills/two-by-two-grid-overview/SKILL.md +78 -0
- dataface/ai/skills/two-by-two-grid-overview/examples/two-by-two-grid-overview.yml +64 -0
- dataface/ai/tool_schemas.py +132 -0
- dataface/ai/tools/__init__.py +312 -0
- dataface/ai/yaml_utils.py +57 -0
- dataface/cli/__init__.py +3 -0
- dataface/cli/_console.py +48 -0
- dataface/cli/_error_format.py +83 -0
- dataface/cli/_extras.py +190 -0
- dataface/cli/_json_output.py +8 -0
- dataface/cli/_parsing.py +17 -0
- dataface/cli/_version_info.py +56 -0
- dataface/cli/commands/__init__.py +3 -0
- dataface/cli/commands/_agent_input.py +205 -0
- dataface/cli/commands/_agent_server.py +115 -0
- dataface/cli/commands/chat.py +645 -0
- dataface/cli/commands/describe.py +107 -0
- dataface/cli/commands/docs.py +131 -0
- dataface/cli/commands/extension.py +179 -0
- dataface/cli/commands/init.py +240 -0
- dataface/cli/commands/inspect.py +94 -0
- dataface/cli/commands/mcp_init.py +167 -0
- dataface/cli/commands/query.py +386 -0
- dataface/cli/commands/render.py +291 -0
- dataface/cli/commands/schema.py +411 -0
- dataface/cli/commands/search.py +49 -0
- dataface/cli/commands/serve.py +114 -0
- dataface/cli/commands/skills.py +133 -0
- dataface/cli/commands/skills_init.py +161 -0
- dataface/cli/commands/validate.py +63 -0
- dataface/cli/main.py +1501 -0
- dataface/core/__init__.py +75 -0
- dataface/core/compile/__init__.py +244 -0
- dataface/core/compile/_jinja_helpers.py +78 -0
- dataface/core/compile/channel.py +222 -0
- dataface/core/compile/chart_focus.py +101 -0
- dataface/core/compile/chart_resolved.py +169 -0
- dataface/core/compile/chart_type_detection.py +489 -0
- dataface/core/compile/chart_update.py +261 -0
- dataface/core/compile/colors.py +64 -0
- dataface/core/compile/compiler.py +904 -0
- dataface/core/compile/config.py +823 -0
- dataface/core/compile/custom_chart_types.py +208 -0
- dataface/core/compile/data_table_attachment.py +1287 -0
- dataface/core/compile/detect.py +110 -0
- dataface/core/compile/errors.py +302 -0
- dataface/core/compile/filter_injection.py +319 -0
- dataface/core/compile/introspection.py +527 -0
- dataface/core/compile/jinja.py +511 -0
- dataface/core/compile/labels_env.py +52 -0
- dataface/core/compile/markdown.py +154 -0
- dataface/core/compile/meta.py +388 -0
- dataface/core/compile/models/__init__.py +0 -0
- dataface/core/compile/models/chart/__init__.py +0 -0
- dataface/core/compile/models/chart/authored.py +2137 -0
- dataface/core/compile/models/chart/compiled.py +398 -0
- dataface/core/compile/models/config.py +347 -0
- dataface/core/compile/models/face/__init__.py +0 -0
- dataface/core/compile/models/face/authored.py +659 -0
- dataface/core/compile/models/face/compiled.py +522 -0
- dataface/core/compile/models/factories.py +201 -0
- dataface/core/compile/models/markers.py +40 -0
- dataface/core/compile/models/palette.py +36 -0
- dataface/core/compile/models/primitives.py +415 -0
- dataface/core/compile/models/query/__init__.py +0 -0
- dataface/core/compile/models/query/authored.py +246 -0
- dataface/core/compile/models/query/compiled.py +710 -0
- dataface/core/compile/models/refs.py +137 -0
- dataface/core/compile/models/source.py +611 -0
- dataface/core/compile/models/style/__init__.py +0 -0
- dataface/core/compile/models/style/authored.py +481 -0
- dataface/core/compile/models/style/compiled.py +3399 -0
- dataface/core/compile/models/style/merged.py +1682 -0
- dataface/core/compile/models/theme.py +362 -0
- dataface/core/compile/models/variable/__init__.py +0 -0
- dataface/core/compile/models/variable/authored.py +254 -0
- dataface/core/compile/models/vega_lite/__init__.py +0 -0
- dataface/core/compile/models/vega_lite/config.py +510 -0
- dataface/core/compile/models/vega_lite/contracts.py +171 -0
- dataface/core/compile/normalize_charts.py +494 -0
- dataface/core/compile/normalize_layout.py +1000 -0
- dataface/core/compile/normalize_queries.py +297 -0
- dataface/core/compile/normalize_variables.py +489 -0
- dataface/core/compile/normalizer.py +543 -0
- dataface/core/compile/palette.py +1100 -0
- dataface/core/compile/parameterized.py +658 -0
- dataface/core/compile/parser.py +228 -0
- dataface/core/compile/schema.py +20 -0
- dataface/core/compile/schema_renderers/__init__.py +0 -0
- dataface/core/compile/schema_renderers/json_schema.py +163 -0
- dataface/core/compile/schema_renderers/prompt.py +152 -0
- dataface/core/compile/schema_renderers/vscode_schema.py +301 -0
- dataface/core/compile/sizing.py +2126 -0
- dataface/core/compile/sources.py +518 -0
- dataface/core/compile/sql_authoring_lint.py +56 -0
- dataface/core/compile/style_cascade.py +471 -0
- dataface/core/compile/typography.py +299 -0
- dataface/core/compile/validator.py +301 -0
- dataface/core/compile/variables.py +53 -0
- dataface/core/compile/vega_config.py +98 -0
- dataface/core/compile/vega_lite/__init__.py +6 -0
- dataface/core/compile/vega_lite/validation.py +95 -0
- dataface/core/compile/yaml_error_formatter.py +838 -0
- dataface/core/connections.py +38 -0
- dataface/core/dashboard.py +358 -0
- dataface/core/defaults/default_config.yml +101 -0
- dataface/core/defaults/palettes/categorical/category-10-dark.yml +32 -0
- dataface/core/defaults/palettes/categorical/category-10-light.yml +43 -0
- dataface/core/defaults/palettes/categorical/category-10.yml +31 -0
- dataface/core/defaults/palettes/categorical/category-6-tonal-blue.yml +22 -0
- dataface/core/defaults/palettes/categorical/category-6-tonal-brown.yml +29 -0
- dataface/core/defaults/palettes/categorical/category-6-tonal-green.yml +20 -0
- dataface/core/defaults/palettes/categorical/category-6-tonal-orange.yml +21 -0
- dataface/core/defaults/palettes/categorical/category-6-tonal-purple.yml +20 -0
- dataface/core/defaults/palettes/categorical/editorial-10-dark.yml +32 -0
- dataface/core/defaults/palettes/categorical/editorial-10.yml +40 -0
- dataface/core/defaults/palettes/categorical/hero-6.yml +17 -0
- dataface/core/defaults/palettes/categorical/single-blue.yml +11 -0
- dataface/core/defaults/palettes/categorical/tableau.yml +20 -0
- dataface/core/defaults/palettes/data/xkcd_colors.json +3803 -0
- dataface/core/defaults/palettes/diverging/blue-red.yml +25 -0
- dataface/core/defaults/palettes/diverging/coolwarm.yml +24 -0
- dataface/core/defaults/palettes/diverging/crimson-green.yml +23 -0
- dataface/core/defaults/palettes/diverging/orange-teal.yml +23 -0
- dataface/core/defaults/palettes/diverging/sunset.yml +24 -0
- dataface/core/defaults/palettes/scaffold/dft-creams.yml +38 -0
- dataface/core/defaults/palettes/scaffold/dft-grays.yml +53 -0
- dataface/core/defaults/palettes/sequential/amber.yml +22 -0
- dataface/core/defaults/palettes/sequential/blue.yml +22 -0
- dataface/core/defaults/palettes/sequential/brown.yml +22 -0
- dataface/core/defaults/palettes/sequential/gray.yml +22 -0
- dataface/core/defaults/palettes/sequential/green.yml +22 -0
- dataface/core/defaults/palettes/sequential/purple.yml +22 -0
- dataface/core/defaults/palettes/sequential/rust.yml +22 -0
- dataface/core/defaults/palettes/sequential/teal.yml +22 -0
- dataface/core/defaults/palettes/tone/negative.yml +32 -0
- dataface/core/defaults/palettes/tone/positive.yml +22 -0
- dataface/core/defaults/palettes/tone/warning.yml +22 -0
- dataface/core/defaults/themes/_base.yaml +786 -0
- dataface/core/defaults/themes/bi.yaml +16 -0
- dataface/core/defaults/themes/carbong100.yaml +41 -0
- dataface/core/defaults/themes/cream.yaml +122 -0
- dataface/core/defaults/themes/dark.yaml +40 -0
- dataface/core/defaults/themes/diagnostics-title-angle-extreme.yaml +9 -0
- dataface/core/defaults/themes/diagnostics-title-baseline-extreme.yaml +9 -0
- dataface/core/defaults/themes/diagnostics-title-baseline.yaml +24 -0
- dataface/core/defaults/themes/diagnostics-title-center.yaml +8 -0
- dataface/core/defaults/themes/diagnostics-title-color-extreme.yaml +24 -0
- dataface/core/defaults/themes/diagnostics-title-font-extreme.yaml +25 -0
- dataface/core/defaults/themes/diagnostics-title-left.yaml +8 -0
- dataface/core/defaults/themes/diagnostics-title-offset-extreme.yaml +9 -0
- dataface/core/defaults/themes/diagnostics-title-size-extreme.yaml +24 -0
- dataface/core/defaults/themes/diagnostics-title-weight-extreme.yaml +24 -0
- dataface/core/defaults/themes/editorial.yaml +147 -0
- dataface/core/defaults/themes/light.yaml +30 -0
- dataface/core/defaults/themes/looker.yaml +17 -0
- dataface/core/defaults/themes/stark.yaml +134 -0
- dataface/core/errors/__init__.py +67 -0
- dataface/core/errors/codes_compile.py +56 -0
- dataface/core/errors/codes_execute.py +177 -0
- dataface/core/errors/codes_render.py +106 -0
- dataface/core/errors/codes_unknown.py +15 -0
- dataface/core/errors/hints.py +74 -0
- dataface/core/errors/registry.py +42 -0
- dataface/core/errors/structured.py +92 -0
- dataface/core/execute/__init__.py +91 -0
- dataface/core/execute/adapters/__init__.py +49 -0
- dataface/core/execute/adapters/adapter_registry.py +400 -0
- dataface/core/execute/adapters/base.py +245 -0
- dataface/core/execute/adapters/csv_adapter.py +239 -0
- dataface/core/execute/adapters/dbt_adapter.py +283 -0
- dataface/core/execute/adapters/dbt_adapter_factory.py +212 -0
- dataface/core/execute/adapters/dbt_macro_loader.py +95 -0
- dataface/core/execute/adapters/dbt_utils.py +150 -0
- dataface/core/execute/adapters/http_adapter.py +224 -0
- dataface/core/execute/adapters/metricflow_adapter.py +94 -0
- dataface/core/execute/adapters/schema_resolver_adapter.py +144 -0
- dataface/core/execute/adapters/sql_adapter.py +710 -0
- dataface/core/execute/adapters/values_adapter.py +58 -0
- dataface/core/execute/batch.py +744 -0
- dataface/core/execute/cache_backend.py +135 -0
- dataface/core/execute/cache_keys.py +66 -0
- dataface/core/execute/dbt_jinja.py +21 -0
- dataface/core/execute/dialects/__init__.py +121 -0
- dataface/core/execute/dialects/athena.py +75 -0
- dataface/core/execute/dialects/base.py +302 -0
- dataface/core/execute/dialects/bigquery.py +38 -0
- dataface/core/execute/dialects/databricks.py +68 -0
- dataface/core/execute/dialects/duckdb.py +35 -0
- dataface/core/execute/dialects/mysql.py +68 -0
- dataface/core/execute/dialects/postgres.py +39 -0
- dataface/core/execute/dialects/redshift.py +12 -0
- dataface/core/execute/dialects/snowflake.py +51 -0
- dataface/core/execute/dialects/sqlserver.py +92 -0
- dataface/core/execute/duckdb_cache.py +712 -0
- dataface/core/execute/duckdb_config.py +26 -0
- dataface/core/execute/errors.py +213 -0
- dataface/core/execute/executor.py +1249 -0
- dataface/core/execute/parallel.py +162 -0
- dataface/core/execute/setup_sql.py +58 -0
- dataface/core/execute/source_registry.py +72 -0
- dataface/core/execute/source_resolver.py +255 -0
- dataface/core/execute/sql_guard.py +387 -0
- dataface/core/execute/sql_literals.py +199 -0
- dataface/core/fonts.py +52 -0
- dataface/core/inspect/__init__.py +32 -0
- dataface/core/inspect/cache_factory.py +98 -0
- dataface/core/inspect/db_types.py +162 -0
- dataface/core/inspect/dbt_schema.py +96 -0
- dataface/core/inspect/defaults.yml +37 -0
- dataface/core/inspect/fanout_risk.py +109 -0
- dataface/core/inspect/manifest_utils.py +77 -0
- dataface/core/inspect/partials/categorical.yml +40 -0
- dataface/core/inspect/partials/date.yml +40 -0
- dataface/core/inspect/partials/numeric.yml +55 -0
- dataface/core/inspect/partition_types.py +38 -0
- dataface/core/inspect/query_validator.py +975 -0
- dataface/core/inspect/renderer.py +354 -0
- dataface/core/inspect/resolver.py +808 -0
- dataface/core/inspect/search.py +461 -0
- dataface/core/inspect/sources/__init__.py +32 -0
- dataface/core/inspect/sources/dbt.py +738 -0
- dataface/core/inspect/sources/duckdb_utils.py +66 -0
- dataface/core/inspect/templates/__init__.py +1 -0
- dataface/core/inspect/templates/categorical_column.yml +196 -0
- dataface/core/inspect/templates/charts.yml +109 -0
- dataface/core/inspect/templates/date_column.yml +248 -0
- dataface/core/inspect/templates/model.yml +138 -0
- dataface/core/inspect/templates/numeric_column.yml +261 -0
- dataface/core/inspect/templates/quality.yml +80 -0
- dataface/core/inspect/templates/string_column.yml +263 -0
- dataface/core/project_roots.py +165 -0
- dataface/core/render/__init__.py +87 -0
- dataface/core/render/board_links.py +176 -0
- dataface/core/render/chart/__init__.py +27 -0
- dataface/core/render/chart/arc_attached_table.py +251 -0
- dataface/core/render/chart/artifacts.py +16 -0
- dataface/core/render/chart/callout.py +225 -0
- dataface/core/render/chart/decisions.py +358 -0
- dataface/core/render/chart/geo.py +700 -0
- dataface/core/render/chart/kpi.py +916 -0
- dataface/core/render/chart/labels.py +76 -0
- dataface/core/render/chart/pipeline.py +818 -0
- dataface/core/render/chart/presentation.py +36 -0
- dataface/core/render/chart/profile.py +3438 -0
- dataface/core/render/chart/render_single.py +347 -0
- dataface/core/render/chart/renderers.py +193 -0
- dataface/core/render/chart/rendering.py +565 -0
- dataface/core/render/chart/serialization.py +90 -0
- dataface/core/render/chart/spark.py +496 -0
- dataface/core/render/chart/spark_bar.py +370 -0
- dataface/core/render/chart/spec_builders.py +154 -0
- dataface/core/render/chart/standard_renderer.py +2645 -0
- dataface/core/render/chart/table.py +2957 -0
- dataface/core/render/chart/table_support.py +1452 -0
- dataface/core/render/chart/tick_values.py +66 -0
- dataface/core/render/chart/time_unit_detect.py +809 -0
- dataface/core/render/chart/title_overflow.py +157 -0
- dataface/core/render/chart/type_inference.py +122 -0
- dataface/core/render/chart/validation.py +99 -0
- dataface/core/render/chart/vega_lite.py +125 -0
- dataface/core/render/chart/vega_lite_types.py +268 -0
- dataface/core/render/chart/vl_field_maps.py +346 -0
- dataface/core/render/chart_interactivity.py +24 -0
- dataface/core/render/control_registry.py +287 -0
- dataface/core/render/converters/__init__.py +24 -0
- dataface/core/render/converters/chart.py +276 -0
- dataface/core/render/converters/html.py +98 -0
- dataface/core/render/converters/pdf.py +40 -0
- dataface/core/render/converters/png.py +41 -0
- dataface/core/render/errors.py +144 -0
- dataface/core/render/face_api.py +160 -0
- dataface/core/render/faces.py +1194 -0
- dataface/core/render/font_measurement.py +48 -0
- dataface/core/render/font_support.py +197 -0
- dataface/core/render/fonts/DFTSansTabular-Regular.ttf +0 -0
- dataface/core/render/fonts/DFTSansTabular-Regular.woff2 +0 -0
- dataface/core/render/fonts/DFTSerifOldstyleProportional-Regular.ttf +0 -0
- dataface/core/render/fonts/DFTSerifOldstyleTabular-Regular.ttf +0 -0
- dataface/core/render/fonts/InterVariable.ttf +0 -0
- dataface/core/render/fonts/InterVariable.woff2 +0 -0
- dataface/core/render/fonts/NOTO_COLOR_EMOJI_LICENSE.txt +93 -0
- dataface/core/render/fonts/NOTO_EMOJI_LICENSE.txt +93 -0
- dataface/core/render/fonts/NotoColorEmoji-Regular.ttf +0 -0
- dataface/core/render/fonts/NotoColorEmoji-Regular.woff2 +0 -0
- dataface/core/render/fonts/NotoEmoji-Regular.ttf +0 -0
- dataface/core/render/fonts/NotoEmoji-Regular.woff2 +0 -0
- dataface/core/render/fonts/SOURCE_CODE_PRO_LICENSE.txt +93 -0
- dataface/core/render/fonts/SOURCE_SERIF_4_LICENSE.txt +98 -0
- dataface/core/render/fonts/SourceCodePro-Regular.ttf +0 -0
- dataface/core/render/fonts/SourceSerif4-Regular.ttf +0 -0
- dataface/core/render/fonts/_emoji_font_face.css +43 -0
- dataface/core/render/fonts/source-serif-4-variable-latin.woff2 +0 -0
- dataface/core/render/format_utils.py +329 -0
- dataface/core/render/geo_defaults.yml +28 -0
- dataface/core/render/json_format.py +146 -0
- dataface/core/render/layout_sizing.py +865 -0
- dataface/core/render/layouts.py +541 -0
- dataface/core/render/markdown_defaults.yml +16 -0
- dataface/core/render/missing_vars_prompt.py +79 -0
- dataface/core/render/placeholder.py +389 -0
- dataface/core/render/render_result.py +14 -0
- dataface/core/render/renderer.py +467 -0
- dataface/core/render/script_embedding.py +16 -0
- dataface/core/render/svg_utils.py +212 -0
- dataface/core/render/template_loader.py +69 -0
- dataface/core/render/templates/controls/_styles.css +606 -0
- dataface/core/render/templates/controls/checkbox.html +16 -0
- dataface/core/render/templates/controls/date.html +16 -0
- dataface/core/render/templates/controls/number.html +19 -0
- dataface/core/render/templates/controls/readonly.html +9 -0
- dataface/core/render/templates/controls/select.html +21 -0
- dataface/core/render/templates/controls/slider.html +22 -0
- dataface/core/render/templates/controls/text.html +16 -0
- dataface/core/render/templates/scripts/chart_interactivity.js +191 -0
- dataface/core/render/templates/scripts/variables.js +976 -0
- dataface/core/render/templates/svg/grid_pattern.svg +3 -0
- dataface/core/render/templates/svg/styles.css +51 -0
- dataface/core/render/terminal.py +311 -0
- dataface/core/render/terminal_charts.py +563 -0
- dataface/core/render/terminal_defaults.yml +2 -0
- dataface/core/render/terminal_layouts.py +299 -0
- dataface/core/render/terminal_text.py +31 -0
- dataface/core/render/text/__init__.py +1 -0
- dataface/core/render/text/case.py +113 -0
- dataface/core/render/text_format.py +129 -0
- dataface/core/render/utils.py +106 -0
- dataface/core/render/variable_controls.py +946 -0
- dataface/core/render/variable_input_refinement.py +140 -0
- dataface/core/render/warnings/__init__.py +15 -0
- dataface/core/render/warnings/bar_color_1_to_1_with_x.py +80 -0
- dataface/core/render/warnings/base.py +44 -0
- dataface/core/render/warnings/fanout_risk.py +15 -0
- dataface/core/render/warnings/from_query_diagnostic.py +56 -0
- dataface/core/render/warnings/missing_join_predicate.py +13 -0
- dataface/core/render/warnings/query_parse_error.py +14 -0
- dataface/core/render/warnings/query_returned_zero_rows.py +42 -0
- dataface/core/render/warnings/reaggregation.py +14 -0
- dataface/core/render/warnings/registry.py +45 -0
- dataface/core/render/warnings/suppression.py +46 -0
- dataface/core/render/warnings/temporal_single_point.py +63 -0
- dataface/core/render/warnings/unreferenced_chart.py +15 -0
- dataface/core/render/warnings/y_encoding_mostly_null.py +76 -0
- dataface/core/render/yaml_format.py +167 -0
- dataface/core/resolve_face.py +195 -0
- dataface/core/schema/__init__.py +0 -0
- dataface/core/schema/guidance.py +151 -0
- dataface/core/scoped_paths.py +59 -0
- dataface/core/serve/__init__.py +14 -0
- dataface/core/serve/bootstrap.py +39 -0
- dataface/core/serve/embedded.py +57 -0
- dataface/core/serve/port.py +129 -0
- dataface/core/serve/server.py +938 -0
- dataface/core/serve/templates/__init__.py +0 -0
- dataface/core/serve/templates/directory.yml +6 -0
- dataface/core/serve/templates/error.html.j2 +217 -0
- dataface/core/utils.py +121 -0
- dataface/core/validate.py +64 -0
- dataface/integrations/__init__.py +0 -0
- dataface/integrations/highlighting.py +351 -0
- dataface/integrations/markdown.py +537 -0
- dataface/py.typed +0 -0
- dataface-0.1.2.dist-info/METADATA +375 -0
- dataface-0.1.2.dist-info/RECORD +455 -0
- dataface-0.1.2.dist-info/WHEEL +4 -0
- dataface-0.1.2.dist-info/entry_points.txt +2 -0
- dataface-0.1.2.dist-info/licenses/LICENSE +202 -0
- mdsvg/__init__.py +168 -0
- mdsvg/fonts.py +656 -0
- mdsvg/images.py +299 -0
- mdsvg/parser.py +629 -0
- mdsvg/playground.py +284 -0
- mdsvg/py.typed +2 -0
- mdsvg/renderer.py +1623 -0
- mdsvg/style.py +355 -0
- mdsvg/types.py +200 -0
- mdsvg/utils.py +86 -0
mdsvg/playground.py
ADDED
|
@@ -0,0 +1,284 @@
|
|
|
1
|
+
"""
|
|
2
|
+
Playground module for markdown-svg.
|
|
3
|
+
|
|
4
|
+
This provides a simple web-based playground for experimenting with markdown-svg.
|
|
5
|
+
Run it with: mdsvg-playground
|
|
6
|
+
Or: python -m mdsvg.playground
|
|
7
|
+
"""
|
|
8
|
+
|
|
9
|
+
import json
|
|
10
|
+
import sys
|
|
11
|
+
from http.server import HTTPServer, SimpleHTTPRequestHandler
|
|
12
|
+
from pathlib import Path
|
|
13
|
+
from typing import Any, Dict, List
|
|
14
|
+
|
|
15
|
+
from .renderer import render
|
|
16
|
+
from .style import Style
|
|
17
|
+
|
|
18
|
+
# Style options that can be passed from the frontend
|
|
19
|
+
STYLE_OPTIONS = {
|
|
20
|
+
"font_family",
|
|
21
|
+
"mono_font_family",
|
|
22
|
+
"base_font_size",
|
|
23
|
+
"line_height",
|
|
24
|
+
"text_color",
|
|
25
|
+
"heading_color",
|
|
26
|
+
"link_color",
|
|
27
|
+
"link_underline",
|
|
28
|
+
"code_color",
|
|
29
|
+
"code_background",
|
|
30
|
+
"blockquote_color",
|
|
31
|
+
"blockquote_border_color",
|
|
32
|
+
"h1_scale",
|
|
33
|
+
"h2_scale",
|
|
34
|
+
"h3_scale",
|
|
35
|
+
"h4_scale",
|
|
36
|
+
"h5_scale",
|
|
37
|
+
"h6_scale",
|
|
38
|
+
"heading_font_weight",
|
|
39
|
+
"heading_margin_top",
|
|
40
|
+
"heading_margin_bottom",
|
|
41
|
+
"paragraph_spacing",
|
|
42
|
+
"list_indent",
|
|
43
|
+
"list_item_spacing",
|
|
44
|
+
"code_block_padding",
|
|
45
|
+
"code_block_border_radius",
|
|
46
|
+
"blockquote_padding",
|
|
47
|
+
"blockquote_border_width",
|
|
48
|
+
"table_border_color",
|
|
49
|
+
"table_header_background",
|
|
50
|
+
"table_cell_padding",
|
|
51
|
+
"hr_color",
|
|
52
|
+
"hr_height",
|
|
53
|
+
"char_width_ratio",
|
|
54
|
+
"bold_char_width_ratio",
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
def get_playground_dir() -> Path:
|
|
59
|
+
"""Get the playground directory path."""
|
|
60
|
+
# Check if running from source (development)
|
|
61
|
+
src_playground = Path(__file__).parent.parent.parent / "playground"
|
|
62
|
+
if src_playground.exists():
|
|
63
|
+
return src_playground
|
|
64
|
+
|
|
65
|
+
# Check if installed as package
|
|
66
|
+
import importlib.resources
|
|
67
|
+
|
|
68
|
+
try:
|
|
69
|
+
# Python 3.9+
|
|
70
|
+
files = importlib.resources.files("mdsvg")
|
|
71
|
+
playground_path = Path(str(files)) / ".." / ".." / "playground"
|
|
72
|
+
if playground_path.exists():
|
|
73
|
+
return playground_path
|
|
74
|
+
except (AttributeError, TypeError):
|
|
75
|
+
pass
|
|
76
|
+
|
|
77
|
+
# Fallback to checking relative to this file
|
|
78
|
+
return Path(__file__).parent.parent.parent / "playground"
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
def build_style(data: Dict[str, Any]) -> Style:
|
|
82
|
+
"""Build a Style object from request data."""
|
|
83
|
+
style_kwargs = {k: v for k, v in data.items() if k in STYLE_OPTIONS}
|
|
84
|
+
return Style(**style_kwargs)
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
def list_examples(examples_dir: Path) -> List[Dict[str, str]]:
|
|
88
|
+
"""List all example markdown files."""
|
|
89
|
+
examples: List[Dict[str, str]] = []
|
|
90
|
+
if examples_dir.exists():
|
|
91
|
+
for path in sorted(examples_dir.glob("*.md")):
|
|
92
|
+
name = path.stem.replace("-", " ").replace("_", " ").title()
|
|
93
|
+
examples.append(
|
|
94
|
+
{
|
|
95
|
+
"name": name,
|
|
96
|
+
"filename": path.name,
|
|
97
|
+
}
|
|
98
|
+
)
|
|
99
|
+
return examples
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
def load_example(examples_dir: Path, filename: str) -> str:
|
|
103
|
+
"""Load an example file content."""
|
|
104
|
+
path = examples_dir / filename
|
|
105
|
+
if path.exists() and path.suffix == ".md":
|
|
106
|
+
return path.read_text()
|
|
107
|
+
return ""
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
class PlaygroundHandler(SimpleHTTPRequestHandler):
|
|
111
|
+
"""HTTP handler for the playground."""
|
|
112
|
+
|
|
113
|
+
playground_dir: Path
|
|
114
|
+
examples_dir: Path
|
|
115
|
+
|
|
116
|
+
def __init__(self, *args: Any, **kwargs: Any) -> None:
|
|
117
|
+
# Set directory to playground folder
|
|
118
|
+
super().__init__(*args, directory=str(self.playground_dir), **kwargs)
|
|
119
|
+
|
|
120
|
+
def do_GET(self) -> None:
|
|
121
|
+
"""Handle GET requests."""
|
|
122
|
+
from urllib.parse import urlparse
|
|
123
|
+
|
|
124
|
+
parsed = urlparse(self.path)
|
|
125
|
+
path = parsed.path
|
|
126
|
+
|
|
127
|
+
if path == "/api/examples":
|
|
128
|
+
self._send_json(list_examples(self.examples_dir))
|
|
129
|
+
elif path.startswith("/api/example/"):
|
|
130
|
+
filename = path.split("/")[-1]
|
|
131
|
+
content = load_example(self.examples_dir, filename)
|
|
132
|
+
if content:
|
|
133
|
+
self._send_json({"content": content})
|
|
134
|
+
else:
|
|
135
|
+
self._send_error(404, "Example not found")
|
|
136
|
+
else:
|
|
137
|
+
# Serve static files
|
|
138
|
+
super().do_GET()
|
|
139
|
+
|
|
140
|
+
def do_POST(self) -> None:
|
|
141
|
+
"""Handle POST requests."""
|
|
142
|
+
from urllib.parse import urlparse
|
|
143
|
+
|
|
144
|
+
parsed = urlparse(self.path)
|
|
145
|
+
path = parsed.path
|
|
146
|
+
|
|
147
|
+
if path == "/api/render":
|
|
148
|
+
content_length = int(self.headers.get("Content-Length", 0))
|
|
149
|
+
body = self.rfile.read(content_length)
|
|
150
|
+
|
|
151
|
+
try:
|
|
152
|
+
data = json.loads(body)
|
|
153
|
+
markdown = data.get("markdown", "")
|
|
154
|
+
width = data.get("width", 600)
|
|
155
|
+
padding = data.get("padding", 20)
|
|
156
|
+
|
|
157
|
+
style = build_style(data)
|
|
158
|
+
|
|
159
|
+
svg = render(
|
|
160
|
+
markdown,
|
|
161
|
+
width=width,
|
|
162
|
+
padding=padding,
|
|
163
|
+
style=style,
|
|
164
|
+
)
|
|
165
|
+
|
|
166
|
+
self._send_json({"svg": svg})
|
|
167
|
+
except json.JSONDecodeError:
|
|
168
|
+
self._send_error(400, "Invalid JSON")
|
|
169
|
+
except Exception as e: # noqa: BLE001
|
|
170
|
+
self._send_error(500, str(e))
|
|
171
|
+
else:
|
|
172
|
+
self._send_error(404, "Not found")
|
|
173
|
+
|
|
174
|
+
def _send_json(self, data: Any) -> None:
|
|
175
|
+
"""Send a JSON response."""
|
|
176
|
+
body = json.dumps(data).encode("utf-8")
|
|
177
|
+
self.send_response(200)
|
|
178
|
+
self.send_header("Content-Type", "application/json")
|
|
179
|
+
self.send_header("Content-Length", str(len(body)))
|
|
180
|
+
self.send_header("Access-Control-Allow-Origin", "*")
|
|
181
|
+
self.end_headers()
|
|
182
|
+
self.wfile.write(body)
|
|
183
|
+
|
|
184
|
+
def _send_error(self, code: int, message: str) -> None:
|
|
185
|
+
"""Send an error response."""
|
|
186
|
+
body = json.dumps({"error": message}).encode("utf-8")
|
|
187
|
+
self.send_response(code)
|
|
188
|
+
self.send_header("Content-Type", "application/json")
|
|
189
|
+
self.send_header("Content-Length", str(len(body)))
|
|
190
|
+
self.end_headers()
|
|
191
|
+
self.wfile.write(body)
|
|
192
|
+
|
|
193
|
+
def do_OPTIONS(self) -> None:
|
|
194
|
+
"""Handle CORS preflight."""
|
|
195
|
+
self.send_response(200)
|
|
196
|
+
self.send_header("Access-Control-Allow-Origin", "*")
|
|
197
|
+
self.send_header("Access-Control-Allow-Methods", "GET, POST, OPTIONS")
|
|
198
|
+
self.send_header("Access-Control-Allow-Headers", "Content-Type")
|
|
199
|
+
self.end_headers()
|
|
200
|
+
|
|
201
|
+
def log_message(self, format: str, *args: Any) -> None:
|
|
202
|
+
"""Log with color."""
|
|
203
|
+
method = args[0].split()[0] if args else ""
|
|
204
|
+
if method == "POST":
|
|
205
|
+
color = "\033[33m" # Yellow
|
|
206
|
+
elif "200" in str(args[1]) if len(args) > 1 else False:
|
|
207
|
+
color = "\033[32m" # Green
|
|
208
|
+
else:
|
|
209
|
+
color = "\033[0m" # Default
|
|
210
|
+
reset = "\033[0m"
|
|
211
|
+
print(f"{color}{self.address_string()} - {format % args}{reset}")
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
def run_server(host: str = "localhost", port: int = 8765) -> None:
|
|
215
|
+
"""Run the playground server."""
|
|
216
|
+
playground_dir = get_playground_dir()
|
|
217
|
+
examples_dir = playground_dir / "examples"
|
|
218
|
+
|
|
219
|
+
if not playground_dir.exists() or not (playground_dir / "index.html").exists():
|
|
220
|
+
print(
|
|
221
|
+
"""
|
|
222
|
+
╔═══════════════════════════════════════════════════════════════════╗
|
|
223
|
+
║ ║
|
|
224
|
+
║ Playground files not found! ║
|
|
225
|
+
║ ║
|
|
226
|
+
║ The playground is only available when running from source. ║
|
|
227
|
+
║ ║
|
|
228
|
+
║ To use the playground: ║
|
|
229
|
+
║ ║
|
|
230
|
+
║ 1. Clone the repository: ║
|
|
231
|
+
║ git clone https://github.com/davefowler/markdown-svg ║
|
|
232
|
+
║ ║
|
|
233
|
+
║ 2. Run the playground: ║
|
|
234
|
+
║ cd markdown-svg ║
|
|
235
|
+
║ python playground/server.py ║
|
|
236
|
+
║ ║
|
|
237
|
+
╚═══════════════════════════════════════════════════════════════════╝
|
|
238
|
+
"""
|
|
239
|
+
)
|
|
240
|
+
sys.exit(1)
|
|
241
|
+
|
|
242
|
+
# Set class variables for the handler
|
|
243
|
+
PlaygroundHandler.playground_dir = playground_dir
|
|
244
|
+
PlaygroundHandler.examples_dir = examples_dir
|
|
245
|
+
|
|
246
|
+
server_address = (host, port)
|
|
247
|
+
httpd = HTTPServer(server_address, PlaygroundHandler)
|
|
248
|
+
|
|
249
|
+
print(
|
|
250
|
+
f"""
|
|
251
|
+
╔═══════════════════════════════════════════════════════════╗
|
|
252
|
+
║ ║
|
|
253
|
+
║ 🎨 markdown-svg Playground ║
|
|
254
|
+
║ ║
|
|
255
|
+
║ Open in your browser: ║
|
|
256
|
+
║ → http://{host}:{port:<5} ║
|
|
257
|
+
║ ║
|
|
258
|
+
║ Press Ctrl+C to stop ║
|
|
259
|
+
║ ║
|
|
260
|
+
╚═══════════════════════════════════════════════════════════╝
|
|
261
|
+
"""
|
|
262
|
+
)
|
|
263
|
+
|
|
264
|
+
try:
|
|
265
|
+
httpd.serve_forever()
|
|
266
|
+
except KeyboardInterrupt:
|
|
267
|
+
print("\n\nShutting down...")
|
|
268
|
+
httpd.shutdown()
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
def main() -> None:
|
|
272
|
+
"""Main entry point for the playground."""
|
|
273
|
+
import argparse
|
|
274
|
+
|
|
275
|
+
parser = argparse.ArgumentParser(description="Run the markdown-svg playground")
|
|
276
|
+
parser.add_argument("--host", default="localhost", help="Host to bind to")
|
|
277
|
+
parser.add_argument("--port", type=int, default=8765, help="Port to bind to")
|
|
278
|
+
|
|
279
|
+
args = parser.parse_args()
|
|
280
|
+
run_server(args.host, args.port)
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
if __name__ == "__main__":
|
|
284
|
+
main()
|
mdsvg/py.typed
ADDED