pytableau 0.1.0__tar.gz

pytableau-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,60 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  lint:
+    name: Lint & type-check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install dev dependencies
+        run: pip install -e ".[dev]"
+
+      - name: Ruff lint
+        run: ruff check src tests
+
+      - name: Ruff format check
+        run: ruff format --check src tests
+
+      - name: Mypy
+        run: mypy src/pytableau
+
+  test:
+    name: Tests (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install package with dev dependencies
+        run: pip install -e ".[dev]"
+
+      - name: Run tests
+        run: pytest --cov=pytableau --cov-report=term-missing
+
+      - name: Upload coverage report
+        if: matrix.python-version == '3.12'
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-report
+          path: .coverage

pytableau-0.1.0/.github/workflows/docs.yml

@@ -0,0 +1,46 @@
+name: Docs
+
+on:
+  push:
+    tags:
+      - "v*"
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: github-pages
+  cancel-in-progress: true
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deploy.outputs.page_url }}
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install docs dependencies
+        run: pip install mkdocs mkdocstrings[python]
+
+      - name: Build docs
+        run: mkdocs build
+
+      - name: Upload docs site
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: site
+
+      - name: Deploy to GitHub Pages
+        id: deploy
+        uses: actions/deploy-pages@v4

pytableau-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,29 @@
+name: Publish to PyPI
+
+on:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  id-token: write
+
+jobs:
+  pypi:
+    runs-on: ubuntu-latest
+    environment: release
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build tooling
+        run: python -m pip install --upgrade pip build
+
+      - name: Build distribution artifacts
+        run: python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

pytableau-0.1.0/.gitignore

@@ -0,0 +1,37 @@
+# Python
+__pycache__/
+*.py[cod]
+*.pyo
+*.pyd
+.Python
+
+# Distribution / packaging
+dist/
+build/
+*.egg-info/
+*.egg
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# Testing / coverage
+.pytest_cache/
+.coverage
+coverage.xml
+htmlcov/
+
+# Type checking
+.mypy_cache/
+.ruff_cache/
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+
+# OS
+.DS_Store
+Thumbs.db

pytableau-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Brian Weisberg
+
+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.

pytableau-0.1.0/PKG-INFO

@@ -0,0 +1,177 @@
+Metadata-Version: 2.4
+Name: pytableau
+Version: 0.1.0
+Summary: The unified Python SDK for Tableau workbook engineering
+Project-URL: Homepage, https://github.com/brianlwb/pytableau
+Project-URL: Repository, https://github.com/brianlwb/pytableau
+Project-URL: Bug Tracker, https://github.com/brianlwb/pytableau/issues
+License: MIT
+License-File: LICENSE
+Keywords: data,hyper,tableau,twb,twbx,visualization,workbook
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: lxml>=4.9
+Provides-Extra: all
+Requires-Dist: pandas>=2.0; extra == 'all'
+Requires-Dist: pantab>=5.0; extra == 'all'
+Requires-Dist: tableauhyperapi>=0.0.19; extra == 'all'
+Requires-Dist: tableauserverclient>=0.30; extra == 'all'
+Provides-Extra: dev
+Requires-Dist: click>=8.0; extra == 'dev'
+Requires-Dist: lxml-stubs; extra == 'dev'
+Requires-Dist: mypy>=1.8; extra == 'dev'
+Requires-Dist: pre-commit>=3.0; extra == 'dev'
+Requires-Dist: pytest-cov>=5.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.3; extra == 'dev'
+Provides-Extra: hyper
+Requires-Dist: pantab>=5.0; extra == 'hyper'
+Requires-Dist: tableauhyperapi>=0.0.19; extra == 'hyper'
+Provides-Extra: pandas
+Requires-Dist: pandas>=2.0; extra == 'pandas'
+Provides-Extra: server
+Requires-Dist: tableauserverclient>=0.30; extra == 'server'
+Description-Content-Type: text/markdown
+
+# pytableau
+
+> **What pandas did for tabular data, pytableau does for Tableau workbooks.**
+
+`pytableau` is the unified Python SDK for Tableau workbook engineering. It brings every layer of Tableau workbook manipulation — data, connections, semantic model, presentation, packaging, and server lifecycle — under one coherent, Pythonic API.
+
+## Why pytableau?
+
+The Tableau Python ecosystem is fragmented. Tableau/Salesforce maintains several narrow libraries, each covering a single concern:
+
+| Library | Layer | Limitation |
+|---------|-------|-----------|
+| `tableaudocumentapi` | Connection XML | No calc fields, no viz edits, abandoned 2021 |
+| `tableauhyperapi` | `.hyper` data files | No XML awareness |
+| `pantab` | DataFrame ↔ `.hyper` bridge | No XML awareness |
+| `tableauserverclient` | Server REST API | No local file manipulation |
+
+`pytableau` wraps and integrates all of them behind a single API.
+
+## Install
+
+```bash
+# Core (XML + ZIP only — no optional dependencies)
+pip install pytableau
+
+# With Hyper / extract support
+pip install "pytableau[hyper]"
+
+# With pandas convenience methods
+pip install "pytableau[pandas]"
+
+# With Tableau Server/Cloud integration
+pip install "pytableau[server]"
+
+# Everything
+pip install "pytableau[all]"
+```
+
+## Quick Start
+
+### Open and inspect a workbook
+
+```python
+from pytableau import Workbook
+
+wb = Workbook.open("sales_dashboard.twbx")
+
+print(wb.version)                    # "2024.1"
+print(wb.datasources.names)          # ["Sales Data", "Parameters"]
+print(wb.worksheets.names)           # ["Revenue by Region", "Trend"]
+print(wb.dashboards.names)           # ["Executive Summary"]
+
+catalog = wb.catalog()
+for field in catalog.calculated_fields:
+    print(f"{field.caption}: {field.formula}")
+```
+
+### Swap database connections (CI/CD promotion)
+
+```python
+from pytableau import Workbook
+
+wb = Workbook.open("report.twbx")
+for ds in wb.datasources:
+    for conn in ds.connections:
+        conn.server = "prod-db.corp.com"
+        conn.dbname = "analytics_prod"
+wb.save_as("report_prod.twbx")
+```
+
+### Inject a DataFrame
+
+```python
+from pytableau import Workbook
+import pandas as pd
+
+wb = Workbook.open("template.twbx")
+df = pd.read_csv("fresh_data.csv")
+wb.datasources["Sales Data"].hyper.from_dataframe(df)
+wb.save_as("refreshed_report.twbx")
+```
+
+### Generate a workbook from a template
+
+```python
+from pytableau import Workbook
+import pandas as pd
+
+df = pd.read_csv("q4_revenue.csv")
+
+wb = Workbook.from_template("bar_chart")
+wb.datasources["__PLACEHOLDER_DS__"].hyper.from_dataframe(df)
+wb.template.map_fields({
+    "__DIMENSION__": "Product Category",
+    "__MEASURE__":   "Revenue",
+    "__COLOR__":     "Region",
+})
+wb.parameters["__PARAM_TITLE__"].value = "Q4 2025 Revenue"
+wb.save_as("q4_report.twbx")
+```
+
+### CLI
+
+```bash
+pytableau inspect workbook.twbx
+pytableau diff before.twb after.twb
+pytableau swap workbook.twb --server prod-db.corp.com --db analytics_prod
+```
+
+## Development Status
+
+| Phase | Description | Status |
+|-------|-------------|--------|
+| 0 | Foundation: scaffolding, packaging, constants | In Progress |
+| 1 | Read & Inspect: parse any `.twb`/`.twbx` | Planned |
+| 2 | Connection & Field Mutation | Planned |
+| 3 | Data Layer: `.hyper` integration | Planned |
+| 4 | Template Engine | Planned |
+| 5 | Server Integration | Planned |
+| 6 | Advanced Features | Planned |
+
+## Design Principles
+
+1. **Layer cake, not monolith.** Each Tableau layer maps to a distinct submodule. Engage at any abstraction level.
+2. **Batteries included, escape hatches available.** The Pythonic API covers 90% of use cases; raw `lxml` nodes are always accessible.
+3. **Template-first for presentation.** Build a viz in Desktop, then parameterize it with pytableau.
+4. **Fail loud, fail early.** Validate XML mutations before writing — a corrupt `.twb` is the worst outcome.
+5. **Dependency-light by default.** Core requires only `lxml`. Hyper, server, and pandas are optional extras.
+6. **Version-aware.** Track Tableau Desktop version; warn on incompatible XML.
+
+## License
+
+MIT — see [LICENSE](LICENSE)