quicksight-codegen 0.1.0__tar.gz

quicksight_codegen-0.1.0/.env.example

@@ -0,0 +1,25 @@
+# AWS Configuration for QuickSight deployment
+# Copy this file to .env and fill in your values
+#
+# Usage:
+#   cp .env.example .env
+#   # Edit .env with your values
+#   python scripts/deploy_to_quicksight.py
+
+# AWS Account ID (12-digit number, find in AWS Console top-right corner)
+AWS_ACCOUNT_ID=123456789012
+
+# AWS Region (same region as your QuickSight)
+AWS_REGION=eu-central-1
+
+# QuickSight Dataset ARN
+# Find at: QuickSight > Datasets > [Your Dataset] > Share > Copy ARN
+QUICKSIGHT_DATASET_ARN=arn:aws:quicksight:eu-central-1:123456789012:dataset/your-dataset-id
+
+# QuickSight User ARN (for permissions)
+# Find at: QuickSight > Manage QuickSight > Manage Users > [Your User]
+QUICKSIGHT_USER_ARN=arn:aws:quicksight:eu-central-1:123456789012:user/default/your-email@example.com
+
+# S3 Bucket for full-auto dataset upload (Plan A — requires S3 permissions)
+# Leave empty if using the web console upload workflow (Plan B)
+# S3_BUCKET=my-quicksight-data-bucket

quicksight_codegen-0.1.0/.gitignore

@@ -0,0 +1,224 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+.ipynb_checkpoints/
+*.pyc
+.venv/
+.env
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Project specific
+output/
+*.json
+!pyproject.toml
+*.html
+*.csv
+*.xlsx
+*.pdf
+.DS_Store
+.claude/
+scripts/*.sh
+decisionlog.md
+presentation.md

quicksight_codegen-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 ESG QuickSight Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

quicksight_codegen-0.1.0/PKG-INFO

@@ -0,0 +1,233 @@
+Metadata-Version: 2.4
+Name: quicksight-codegen
+Version: 0.1.0
+Summary: A Python library for generating Amazon QuickSight dashboards as code
+Project-URL: Homepage, https://github.com/YasZl/esg-quicksight-as-code
+Project-URL: Documentation, https://github.com/YasZl/esg-quicksight-as-code#readme
+Author: ESG QuickSight Team
+License-Expression: MIT
+License-File: LICENSE
+Keywords: analytics,aws,bi,codegen,dashboard,quicksight
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.9
+Requires-Dist: python-dotenv>=1.0.0
+Provides-Extra: auto
+Requires-Dist: pandas>=1.5.0; extra == 'auto'
+Provides-Extra: aws
+Requires-Dist: boto3>=1.26.0; extra == 'aws'
+Provides-Extra: dev
+Requires-Dist: pandas>=1.5.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
+Requires-Dist: pytest>=7.0.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# quicksight-codegen
+
+Generate and deploy Amazon QuickSight dashboards from any CSV file. One command, zero manual configuration.
+
+```bash
+# Preview locally (no AWS needed)
+quicksight-codegen preview --csv your_data.csv
+
+# Deploy to QuickSight
+quicksight-codegen deploy --csv your_data.csv --dataset "your-dataset" --name "My Dashboard"
+```
+
+The tool automatically analyzes your CSV columns, picks the right chart types (KPI, bar, pie, heatmap, table), adds interactive filters, and handles data type conversion — all as code.
+
+## Quick Start
+
+### 1. Install
+
+```bash
+git clone https://github.com/AzerMusic/esg-quicksight-as-code.git
+cd esg-quicksight-as-code
+
+# Using uv (recommended)
+uv venv && uv pip install -e ".[aws,auto]"
+
+# Or using pip
+python -m venv .venv && source .venv/bin/activate
+pip install -e ".[aws,auto]"
+```
+
+### 2. Preview locally (no AWS required)
+
+```bash
+quicksight-codegen preview --csv your_data.csv --name "My Dashboard"
+```
+
+This generates an HTML file with interactive Chart.js charts you can open in any browser.
+
+### 3. Deploy to AWS QuickSight
+
+**Prerequisites:**
+- AWS CLI configured (`aws configure`)
+- QuickSight activated in your AWS account
+- A dataset uploaded via QuickSight web console ("Upload a file")
+
+**Setup environment:**
+
+```bash
+cp .env.example .env
+# Edit .env with your values (see "Finding Your AWS Values" below)
+```
+
+**Deploy:**
+
+```bash
+# List your datasets to find the right name
+quicksight-codegen list-datasets
+
+# Deploy
+quicksight-codegen deploy \
+  --csv your_data.csv \
+  --dataset "your-dataset-name" \
+  --name "My Dashboard"
+```
+
+The tool will:
+- Auto-detect your AWS account ID, region, and QuickSight user
+- Generate KPIs, charts, heatmaps, and tables based on your data
+- Add dropdown filters for categorical columns (Sector, Region, etc.)
+- Create `parseDecimal()` calculated fields so numeric columns work without manual type fixing
+- Deploy as a QuickSight Analysis you can open immediately
+
+## Finding Your AWS Values
+
+| Variable | Where to find it |
+|----------|-----------------|
+| `AWS_ACCOUNT_ID` | AWS Console top-right corner, or run `aws sts get-caller-identity` |
+| `AWS_REGION` | The region where QuickSight is activated (e.g., `eu-central-1`) |
+| `QUICKSIGHT_DATASET_ARN` | QuickSight > Datasets > your dataset > Share > Copy ARN |
+| `QUICKSIGHT_USER_ARN` | QuickSight > Manage QuickSight > Manage Users > your user |
+
+Most of these are **auto-detected** if your AWS CLI is configured. You only need `.env` if auto-detection doesn't work for your setup.
+
+## CLI Commands
+
+| Command | Description |
+|---------|-------------|
+| `quicksight-codegen preview --csv data.csv` | Generate local HTML preview |
+| `quicksight-codegen deploy --csv data.csv --dataset "name" --name "title"` | Generate and deploy to QuickSight |
+| `quicksight-codegen list-datasets` | List available QuickSight datasets |
+| `quicksight-codegen fix-types --csv data.csv --dataset "name"` | Fix dataset column types (SPICE datasets only) |
+
+### Deploy options
+
+```bash
+quicksight-codegen deploy \
+  --csv data.csv \            # Path to CSV or Excel file
+  --dataset "my-dataset" \    # Dataset name in QuickSight
+  --name "My Dashboard" \     # Dashboard title
+  --id "my-dashboard-v1" \    # Analysis ID (optional, auto-generated from name)
+  --region eu-central-1 \     # AWS region (optional, auto-detected)
+  --update \                  # Update existing analysis instead of creating new
+  --dry-run \                 # Generate JSON only, don't deploy
+  --fix-types                 # Fix column types before deploying (SPICE datasets only)
+```
+
+## How It Works
+
+```
+CSV file
+  |
+  v
+Column analysis (numeric vs categorical)
+  |
+  +--> KPI visuals for key numeric columns
+  +--> Bar/Pie charts for numeric × categorical
+  +--> Heatmap for numeric × 2 categoricals
+  +--> Data table with all columns
+  +--> Dropdown filters for categorical columns
+  +--> parseDecimal() calculated fields for numeric columns
+  |
+  v
+QuickSight Analysis JSON + HTML preview
+  |
+  v
+Deploy via boto3 API
+```
+
+**Key feature: automatic type conversion.** When you upload a CSV to QuickSight, all columns become STRING type. Charts need DECIMAL columns for numeric data. This tool automatically generates `parseDecimal()` calculated fields in the Analysis definition, so charts work immediately without manual type fixing in the QuickSight console.
+
+## Python API
+
+For programmatic use, the library exposes all QuickSight visual types:
+
+```python
+from quicksight_codegen import (
+    auto_dashboard,          # Auto-generate from CSV
+    BarChartVisual,          # Manual visual construction
+    KPIVisual,
+    PieChartVisual,
+    TableVisual,
+    HeatMapVisual,
+    deploy_analysis,         # Deploy to AWS
+    simulate_deploy,         # Generate JSON without AWS
+    generate_html_preview,   # Local HTML preview
+)
+
+# Auto mode: one function call
+analysis, html_path = auto_dashboard(
+    data="your_data.csv",
+    name="My Dashboard",
+    output_dir="output/",
+)
+
+# Manual mode: full control over each visual
+bar = BarChartVisual("bar-1")
+bar.add_categorical_dimension_field("Region", "dataset")
+bar.add_numerical_measure_field("Revenue", "dataset", "SUM")
+```
+
+See `examples/` for complete examples.
+
+## Supported Visual Types
+
+**Basic:** BarChart, LineChart, Table, PivotTable, KPI, PieChart, ScatterPlot
+
+**Advanced:** TreeMap, HeatMap, FilledMap, GeospatialMap, FunnelChart, Waterfall, BoxPlot, GaugeChart
+
+## Project Structure
+
+```
+src/quicksight_codegen/
+  __init__.py         # Public API exports
+  auto.py             # Auto dashboard generation from CSV
+  cli.py              # CLI tool (preview, deploy, list-datasets, fix-types)
+  analysis.py         # Analysis definition, sheets, calculated fields
+  deploy.py           # AWS QuickSight deployment via boto3
+  discovery.py        # Auto-detect AWS account, region, user, datasets
+  preview.py          # HTML preview with Chart.js
+  filters.py          # Filter types and dropdown controls
+  dataset.py          # Dataset type inference and fixing
+  visuals/            # All visual type classes
+  templates/          # Pre-built dashboard templates (ESG, portfolio)
+```
+
+## Running Tests
+
+```bash
+uv pip install -e ".[dev]"
+uv run pytest
+```
+
+## Authors
+
+- Weihua SHI
+- Yasmine ZEROUAL
+- Adam TOUCHANE
+- Saber BERREHILI
+- Amine MEGHAGHI
+
+## License
+
+MIT

quicksight_codegen-0.1.0/README.md

@@ -0,0 +1,203 @@
+# quicksight-codegen
+
+Generate and deploy Amazon QuickSight dashboards from any CSV file. One command, zero manual configuration.
+
+```bash
+# Preview locally (no AWS needed)
+quicksight-codegen preview --csv your_data.csv
+
+# Deploy to QuickSight
+quicksight-codegen deploy --csv your_data.csv --dataset "your-dataset" --name "My Dashboard"
+```
+
+The tool automatically analyzes your CSV columns, picks the right chart types (KPI, bar, pie, heatmap, table), adds interactive filters, and handles data type conversion — all as code.
+
+## Quick Start
+
+### 1. Install
+
+```bash
+git clone https://github.com/AzerMusic/esg-quicksight-as-code.git
+cd esg-quicksight-as-code
+
+# Using uv (recommended)
+uv venv && uv pip install -e ".[aws,auto]"
+
+# Or using pip
+python -m venv .venv && source .venv/bin/activate
+pip install -e ".[aws,auto]"
+```
+
+### 2. Preview locally (no AWS required)
+
+```bash
+quicksight-codegen preview --csv your_data.csv --name "My Dashboard"
+```
+
+This generates an HTML file with interactive Chart.js charts you can open in any browser.
+
+### 3. Deploy to AWS QuickSight
+
+**Prerequisites:**
+- AWS CLI configured (`aws configure`)
+- QuickSight activated in your AWS account
+- A dataset uploaded via QuickSight web console ("Upload a file")
+
+**Setup environment:**
+
+```bash
+cp .env.example .env
+# Edit .env with your values (see "Finding Your AWS Values" below)
+```
+
+**Deploy:**
+
+```bash
+# List your datasets to find the right name
+quicksight-codegen list-datasets
+
+# Deploy
+quicksight-codegen deploy \
+  --csv your_data.csv \
+  --dataset "your-dataset-name" \
+  --name "My Dashboard"
+```
+
+The tool will:
+- Auto-detect your AWS account ID, region, and QuickSight user
+- Generate KPIs, charts, heatmaps, and tables based on your data
+- Add dropdown filters for categorical columns (Sector, Region, etc.)
+- Create `parseDecimal()` calculated fields so numeric columns work without manual type fixing
+- Deploy as a QuickSight Analysis you can open immediately
+
+## Finding Your AWS Values
+
+| Variable | Where to find it |
+|----------|-----------------|
+| `AWS_ACCOUNT_ID` | AWS Console top-right corner, or run `aws sts get-caller-identity` |
+| `AWS_REGION` | The region where QuickSight is activated (e.g., `eu-central-1`) |
+| `QUICKSIGHT_DATASET_ARN` | QuickSight > Datasets > your dataset > Share > Copy ARN |
+| `QUICKSIGHT_USER_ARN` | QuickSight > Manage QuickSight > Manage Users > your user |
+
+Most of these are **auto-detected** if your AWS CLI is configured. You only need `.env` if auto-detection doesn't work for your setup.
+
+## CLI Commands
+
+| Command | Description |
+|---------|-------------|
+| `quicksight-codegen preview --csv data.csv` | Generate local HTML preview |
+| `quicksight-codegen deploy --csv data.csv --dataset "name" --name "title"` | Generate and deploy to QuickSight |
+| `quicksight-codegen list-datasets` | List available QuickSight datasets |
+| `quicksight-codegen fix-types --csv data.csv --dataset "name"` | Fix dataset column types (SPICE datasets only) |
+
+### Deploy options
+
+```bash
+quicksight-codegen deploy \
+  --csv data.csv \            # Path to CSV or Excel file
+  --dataset "my-dataset" \    # Dataset name in QuickSight
+  --name "My Dashboard" \     # Dashboard title
+  --id "my-dashboard-v1" \    # Analysis ID (optional, auto-generated from name)
+  --region eu-central-1 \     # AWS region (optional, auto-detected)
+  --update \                  # Update existing analysis instead of creating new
+  --dry-run \                 # Generate JSON only, don't deploy
+  --fix-types                 # Fix column types before deploying (SPICE datasets only)
+```
+
+## How It Works
+
+```
+CSV file
+  |
+  v
+Column analysis (numeric vs categorical)
+  |
+  +--> KPI visuals for key numeric columns
+  +--> Bar/Pie charts for numeric × categorical
+  +--> Heatmap for numeric × 2 categoricals
+  +--> Data table with all columns
+  +--> Dropdown filters for categorical columns
+  +--> parseDecimal() calculated fields for numeric columns
+  |
+  v
+QuickSight Analysis JSON + HTML preview
+  |
+  v
+Deploy via boto3 API
+```
+
+**Key feature: automatic type conversion.** When you upload a CSV to QuickSight, all columns become STRING type. Charts need DECIMAL columns for numeric data. This tool automatically generates `parseDecimal()` calculated fields in the Analysis definition, so charts work immediately without manual type fixing in the QuickSight console.
+
+## Python API
+
+For programmatic use, the library exposes all QuickSight visual types:
+
+```python
+from quicksight_codegen import (
+    auto_dashboard,          # Auto-generate from CSV
+    BarChartVisual,          # Manual visual construction
+    KPIVisual,
+    PieChartVisual,
+    TableVisual,
+    HeatMapVisual,
+    deploy_analysis,         # Deploy to AWS
+    simulate_deploy,         # Generate JSON without AWS
+    generate_html_preview,   # Local HTML preview
+)
+
+# Auto mode: one function call
+analysis, html_path = auto_dashboard(
+    data="your_data.csv",
+    name="My Dashboard",
+    output_dir="output/",
+)
+
+# Manual mode: full control over each visual
+bar = BarChartVisual("bar-1")
+bar.add_categorical_dimension_field("Region", "dataset")
+bar.add_numerical_measure_field("Revenue", "dataset", "SUM")
+```
+
+See `examples/` for complete examples.
+
+## Supported Visual Types
+
+**Basic:** BarChart, LineChart, Table, PivotTable, KPI, PieChart, ScatterPlot
+
+**Advanced:** TreeMap, HeatMap, FilledMap, GeospatialMap, FunnelChart, Waterfall, BoxPlot, GaugeChart
+
+## Project Structure
+
+```
+src/quicksight_codegen/
+  __init__.py         # Public API exports
+  auto.py             # Auto dashboard generation from CSV
+  cli.py              # CLI tool (preview, deploy, list-datasets, fix-types)
+  analysis.py         # Analysis definition, sheets, calculated fields
+  deploy.py           # AWS QuickSight deployment via boto3
+  discovery.py        # Auto-detect AWS account, region, user, datasets
+  preview.py          # HTML preview with Chart.js
+  filters.py          # Filter types and dropdown controls
+  dataset.py          # Dataset type inference and fixing
+  visuals/            # All visual type classes
+  templates/          # Pre-built dashboard templates (ESG, portfolio)
+```
+
+## Running Tests
+
+```bash
+uv pip install -e ".[dev]"
+uv run pytest
+```
+
+## Authors
+
+- Weihua SHI
+- Yasmine ZEROUAL
+- Adam TOUCHANE
+- Saber BERREHILI
+- Amine MEGHAGHI
+
+## License
+
+MIT