xmlppt 0.1.0__tar.gz

xmlppt-0.1.0/PKG-INFO

@@ -0,0 +1,102 @@
+Metadata-Version: 2.4
+Name: xmlppt
+Version: 0.1.0
+Summary: PowerPoint editing via Open XML package manipulation
+Author: Your Name
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/jlondon626/powerpoint_editor
+Project-URL: Repository, https://github.com/jlondon626/powerpoint_editor
+Keywords: pptx,powerpoint,openxml,slides,excel
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Operating System :: Microsoft :: Windows
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: lxml>=4.0.0
+Requires-Dist: openpyxl>=3.0.0
+Requires-Dist: pywin32>=306; sys_platform == "win32"
+
+# xmlppt
+
+A small utility package for editing PowerPoint (.pptx) files by
+manipulating the Open XML package directly. It supports duplicating
+template slides, editing named textboxes, updating embedded Excel
+workbooks for charts, and basic listing/debug utilities.
+
+This repository contains a single package `xmlppt` with the main
+implementation in `xmlppt/editor.py` and a minimal `main.py` example
+entrypoint.
+
+Requirements
+- Python 3.10+
+- lxml
+- openpyxl
+- pywin32 (only required for `refresh_chart()` on Windows)
+
+Install
+
+Create a virtual environment and install dependencies:
+
+```bash
+python -m venv .venv
+.venv\Scripts\Activate.ps1   # Windows PowerShell
+pip install -r requirements.txt
+```
+
+Install the package locally for development:
+
+```bash
+pip install -e .
+```
+
+Quick usage (programmatic)
+
+```python
+from xmlppt import PowerPointEditor
+
+editor = PowerPointEditor('input.pptx')
+editor.duplicate_template_slide('RESERVE_WATERFALL')
+editor.edit_textbox_html('AOM Text', '<b>Updated</b>')
+editor.save('output.pptx')
+```
+
+CLI example
+
+Run the example entrypoint which shows basic diagnostics and attempts
+to run a sample flow (expects a marker template slide):
+
+```bash
+python main.py --input example.pptx --run-example
+```
+
+Run tests
+
+```bash
+pytest -q
+```
+
+CI
+
+A GitHub Actions workflow is included at `.github/workflows/python-package.yml`
+that installs the package and runs the test suite on Windows.
+
+Publishing
+
+A release workflow is included at `.github/workflows/publish.yml`.
+When you create a GitHub release and publish it, the workflow will build
+and upload the package to PyPI using the `PYPI_API_TOKEN` secret.
+
+To configure publishing:
+
+1. Create a PyPI API token at https://pypi.org/manage/account/token/
+2. Add it to your repository secrets as `PYPI_API_TOKEN`
+3. Create a release on GitHub
+
+Notes
+- The `refresh_chart()` function uses COM automation to refresh chart
+  visuals inside PowerPoint; this only works on Windows with PowerPoint
+  installed.
+- The package manipulates the raw PPTX (zip) contents; always test on
+  copies of presentations before running on production files.

xmlppt-0.1.0/README.md

@@ -0,0 +1,82 @@
+# xmlppt
+
+A small utility package for editing PowerPoint (.pptx) files by
+manipulating the Open XML package directly. It supports duplicating
+template slides, editing named textboxes, updating embedded Excel
+workbooks for charts, and basic listing/debug utilities.
+
+This repository contains a single package `xmlppt` with the main
+implementation in `xmlppt/editor.py` and a minimal `main.py` example
+entrypoint.
+
+Requirements
+- Python 3.10+
+- lxml
+- openpyxl
+- pywin32 (only required for `refresh_chart()` on Windows)
+
+Install
+
+Create a virtual environment and install dependencies:
+
+```bash
+python -m venv .venv
+.venv\Scripts\Activate.ps1   # Windows PowerShell
+pip install -r requirements.txt
+```
+
+Install the package locally for development:
+
+```bash
+pip install -e .
+```
+
+Quick usage (programmatic)
+
+```python
+from xmlppt import PowerPointEditor
+
+editor = PowerPointEditor('input.pptx')
+editor.duplicate_template_slide('RESERVE_WATERFALL')
+editor.edit_textbox_html('AOM Text', '<b>Updated</b>')
+editor.save('output.pptx')
+```
+
+CLI example
+
+Run the example entrypoint which shows basic diagnostics and attempts
+to run a sample flow (expects a marker template slide):
+
+```bash
+python main.py --input example.pptx --run-example
+```
+
+Run tests
+
+```bash
+pytest -q
+```
+
+CI
+
+A GitHub Actions workflow is included at `.github/workflows/python-package.yml`
+that installs the package and runs the test suite on Windows.
+
+Publishing
+
+A release workflow is included at `.github/workflows/publish.yml`.
+When you create a GitHub release and publish it, the workflow will build
+and upload the package to PyPI using the `PYPI_API_TOKEN` secret.
+
+To configure publishing:
+
+1. Create a PyPI API token at https://pypi.org/manage/account/token/
+2. Add it to your repository secrets as `PYPI_API_TOKEN`
+3. Create a release on GitHub
+
+Notes
+- The `refresh_chart()` function uses COM automation to refresh chart
+  visuals inside PowerPoint; this only works on Windows with PowerPoint
+  installed.
+- The package manipulates the raw PPTX (zip) contents; always test on
+  copies of presentations before running on production files.

xmlppt-0.1.0/pyproject.toml

@@ -0,0 +1,31 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "xmlppt"
+version = "0.1.0"
+description = "PowerPoint editing via Open XML package manipulation"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+authors = [
+    { name = "Your Name" },
+]
+urls = { "Homepage" = "https://github.com/jlondon626/powerpoint_editor", "Repository" = "https://github.com/jlondon626/powerpoint_editor" }
+dependencies = [
+    "lxml>=4.0.0",
+    "openpyxl>=3.0.0",
+    "pywin32>=306; sys_platform == \"win32\"",
+]
+keywords = ["pptx", "powerpoint", "openxml", "slides", "excel"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Operating System :: Microsoft :: Windows",
+]
+
+[tool.setuptools]
+packages = ["xmlppt"]

xmlppt-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

xmlppt-0.1.0/tests/test_editor.py

@@ -0,0 +1,274 @@
+import tempfile
+import zipfile
+import os
+from io import BytesIO
+from openpyxl import Workbook, load_workbook
+from xmlppt import editor as edmod
+from xmlppt import PowerPointEditor
+from lxml import etree
+
+
+P_NS = edmod.P_NS
+A_NS = edmod.A_NS
+R_NS = edmod.R_NS
+
+
+def _make_minimal_pptx(path: str) -> None:
+    """Create a minimal pptx zip with one slide containing a textbox and a table."""
+    # Content types
+    content_types = (
+        '<?xml version="1.0" encoding="UTF-8"?>'
+        '<Types xmlns="http://schemas.openxmlformats.org/package/2006/content-types">'
+        '<Override PartName="/ppt/slides/slide1.xml" ContentType="application/vnd.openxmlformats-officedocument.presentationml.slide+xml"/>'
+        '</Types>'
+    ).encode("utf-8")
+
+    # presentation.xml
+    presentation = (
+        f'<?xml version="1.0" encoding="UTF-8"?>'
+        f'<p:presentation xmlns:p="{P_NS}" xmlns:r="{R_NS}">'
+        f'<p:sldIdLst>'
+        f'<p:sldId id="256" r:id="rId1"/>'
+        f'</p:sldIdLst>'
+        f'</p:presentation>'
+    ).encode("utf-8")
+
+    presentation_rels = (
+        '<?xml version="1.0" encoding="UTF-8"?>'
+        f'<Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships">'
+        f'<Relationship Id="rId1" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/slide" Target="slides/slide1.xml"/>'
+        '</Relationships>'
+    ).encode("utf-8")
+
+    # slide1.xml with a textbox named TestBox and a table named MyTable
+    slide = (
+        f'<?xml version="1.0" encoding="UTF-8"?>'
+        f'<p:sld xmlns:p="{P_NS}" xmlns:a="{A_NS}" xmlns:r="{R_NS}">'
+        f'<p:cSld><p:spTree>'
+        # Textbox
+        f'<p:sp>'
+        f'  <p:nvSpPr><p:cNvPr id="2" name="TestBox"/></p:nvSpPr>'
+        f'  <p:txBody><a:bodyPr/><a:lstStyle/>'
+        f'    <a:p><a:r><a:rPr/><a:t>Hello</a:t></a:r></a:p>'
+        f'  </p:txBody>'
+        f'</p:sp>'
+        # Table in graphicFrame
+        f'<p:graphicFrame>'
+        f'  <p:nvGraphicFramePr><p:cNvPr id="5" name="MyTable"/></p:nvGraphicFramePr>'
+        f'  <a:graphic><a:graphicData uri="http://schemas.openxmlformats.org/drawingml/2006/table">'
+        f'    <a:tbl>'
+        f'      <a:tr>'
+        f'        <a:tc><a:txBody><a:bodyPr/><a:lstStyle/><a:p><a:r><a:t>R1C1</a:t></a:r></a:p></a:txBody></a:tc>'
+        f'        <a:tc><a:txBody><a:bodyPr/><a:lstStyle/><a:p><a:r><a:t>R1C2</a:t></a:r></a:p></a:txBody></a:tc>'
+        f'      </a:tr>'
+        f'      <a:tr>'
+        f'        <a:tc><a:txBody><a:bodyPr/><a:lstStyle/><a:p><a:r><a:t>R2C1</a:t></a:r></a:p></a:txBody></a:tc>'
+        f'        <a:tc><a:txBody><a:bodyPr/><a:lstStyle/><a:p><a:r><a:t>R2C2</a:t></a:r></a:p></a:txBody></a:tc>'
+        f'      </a:tr>'
+        f'    </a:tbl>'
+        f'  </a:graphicData></a:graphic>'
+        f'</p:graphicFrame>'
+        f'</p:spTree></p:cSld></p:sld>'
+    ).encode("utf-8")
+
+    # create zip
+    with zipfile.ZipFile(path, 'w') as z:
+        z.writestr('[Content_Types].xml', content_types)
+        z.writestr('ppt/presentation.xml', presentation)
+        z.writestr('ppt/_rels/presentation.xml.rels', presentation_rels)
+        z.writestr('ppt/slides/slide1.xml', slide)
+
+
+def _make_minimal_pptx_with_chart(path: str) -> None:
+    content_types = (
+        '<?xml version="1.0" encoding="UTF-8"?>'
+        '<Types xmlns="http://schemas.openxmlformats.org/package/2006/content-types">'
+        '<Override PartName="/ppt/slides/slide1.xml" ContentType="application/vnd.openxmlformats-officedocument.presentationml.slide+xml"/>'
+        '<Override PartName="/ppt/charts/chart1.xml" ContentType="application/vnd.openxmlformats-officedocument.drawingml.chart+xml"/>'
+        '<Override PartName="/ppt/embeddings/Microsoft_Excel_Worksheet1.xlsx" ContentType="application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"/>'
+        '</Types>'
+    ).encode('utf-8')
+
+    presentation = (
+        f'<?xml version="1.0" encoding="UTF-8"?>'
+        f'<p:presentation xmlns:p="{P_NS}" xmlns:r="{R_NS}">'
+        f'<p:sldIdLst>'
+        f'<p:sldId id="256" r:id="rId1"/>'
+        f'</p:sldIdLst>'
+        f'</p:presentation>'
+    ).encode('utf-8')
+
+    presentation_rels = (
+        '<?xml version="1.0" encoding="UTF-8"?>'
+        '<Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships">'
+        '<Relationship Id="rId1" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/slide" Target="slides/slide1.xml"/>'
+        '</Relationships>'
+    ).encode('utf-8')
+
+    slide = (
+        f'<?xml version="1.0" encoding="UTF-8"?>'
+        f'<p:sld xmlns:p="{P_NS}" xmlns:a="{A_NS}" xmlns:r="{R_NS}">'
+        f'<p:cSld><p:spTree>'
+        f'<p:graphicFrame>'
+        f'  <p:nvGraphicFramePr><p:cNvPr id="5" name="TestChart"/></p:nvGraphicFramePr>'
+        f'  <a:graphic><a:graphicData uri="http://schemas.openxmlformats.org/drawingml/2006/chart">'
+        f'    <c:chart xmlns:c="{edmod.C_NS}" xmlns:r="{R_NS}" r:id="rId1"/>'
+        f'  </a:graphicData></a:graphic>'
+        f'</p:graphicFrame>'
+        f'</p:spTree></p:cSld></p:sld>'
+    ).encode('utf-8')
+
+    chart_xml = (
+        '<?xml version="1.0" encoding="UTF-8"?>'
+        f'<c:chartSpace xmlns:c="{edmod.C_NS}" xmlns:a="{A_NS}" xmlns:r="{R_NS}">'
+        f'  <c:chart>'
+        f'    <c:plotArea>'
+        f'      <c:barChart>'
+        f'        <c:ser>'
+        f'          <c:cat>'
+        f'            <c:strRef>'
+        f'              <c:strCache>'
+        f'                <c:ptCount val="2"/>'
+        f'                <c:pt idx="0"><c:v>One</c:v></c:pt>'
+        f'                <c:pt idx="1"><c:v>Two</c:v></c:pt>'
+        f'              </c:strCache>'
+        f'            </c:strRef>'
+        f'          </c:cat>'
+        f'          <c:val>'
+        f'            <c:numRef>'
+        f'              <c:numCache>'
+        f'                <c:ptCount val="2"/>'
+        f'                <c:pt idx="0"><c:v>10</c:v></c:pt>'
+        f'                <c:pt idx="1"><c:v>20</c:v></c:pt>'
+        f'              </c:numCache>'
+        f'            </c:numRef>'
+        f'          </c:val>'
+        f'        </c:ser>'
+        f'      </c:barChart>'
+        f'    </c:plotArea>'
+        f'  </c:chart>'
+        f'</c:chartSpace>'
+    ).encode('utf-8')
+
+    chart_rels = (
+        '<?xml version="1.0" encoding="UTF-8"?>'
+        '<Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships">'
+        '<Relationship Id="rId1" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/package" Target="../embeddings/Microsoft_Excel_Worksheet1.xlsx"/>'
+        '</Relationships>'
+    ).encode('utf-8')
+
+    wb = Workbook()
+    ws = wb.active
+    ws.title = 'Sheet1'
+    ws['A1'] = 'Category'
+    ws['B1'] = 'Value'
+    ws['A2'] = 'One'
+    ws['B2'] = 10
+    out = BytesIO()
+    wb.save(out)
+    workbook_bytes = out.getvalue()
+
+    with zipfile.ZipFile(path, 'w') as z:
+        z.writestr('[Content_Types].xml', content_types)
+        z.writestr('ppt/presentation.xml', presentation)
+        z.writestr('ppt/_rels/presentation.xml.rels', presentation_rels)
+        z.writestr('ppt/slides/slide1.xml', slide)
+        z.writestr('ppt/slides/_rels/slide1.xml.rels', (
+            '<?xml version="1.0" encoding="UTF-8"?>'
+            '<Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships">'
+            '<Relationship Id="rId1" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/chart" Target="../charts/chart1.xml"/>'
+            '</Relationships>'
+        ).encode('utf-8'))
+        z.writestr('ppt/charts/chart1.xml', chart_xml)
+        z.writestr('ppt/charts/_rels/chart1.xml.rels', chart_rels)
+        z.writestr('ppt/embeddings/Microsoft_Excel_Worksheet1.xlsx', workbook_bytes)
+
+
+def test_import():
+    import xmlppt
+
+    assert hasattr(xmlppt, 'PowerPointEditor')
+
+
+def test_textbox_find_and_edit(tmp_path):
+    pptx = tmp_path / 'test.pptx'
+    _make_minimal_pptx(str(pptx))
+
+    editor = PowerPointEditor(str(pptx))
+
+    found = editor.find_textbox_anywhere('TestBox')
+    assert found['slide_number'] == 1
+
+    editor.edit_textbox_on_slide(1, 'TestBox', 'New\nLine')
+
+    slide_xml = editor.files['ppt/slides/slide1.xml'].decode('utf-8')
+    assert 'New' in slide_xml
+    assert 'Line' in slide_xml
+
+
+def test_table_find_and_edit_cell(tmp_path):
+    pptx = tmp_path / 'test_table.pptx'
+    _make_minimal_pptx(str(pptx))
+
+    editor = PowerPointEditor(str(pptx))
+
+    found = editor.find_table_anywhere('MyTable')
+    assert found['slide_number'] == 1
+
+    editor.edit_table_cell_on_slide(1, 'MyTable', 0, 1, 'NEWVAL')
+
+    slide_xml = editor.files['ppt/slides/slide1.xml'].decode('utf-8')
+    assert 'NEWVAL' in slide_xml
+
+
+def test_table_edit_range(tmp_path):
+    pptx = tmp_path / 'test_table2.pptx'
+    _make_minimal_pptx(str(pptx))
+
+    editor = PowerPointEditor(str(pptx))
+
+    data = [['A1', 'A2'], ['B1', 'B2']]
+    editor.edit_table_range_on_slide(1, 'MyTable', data)
+
+    slide_xml = editor.files['ppt/slides/slide1.xml'].decode('utf-8')
+    assert 'A1' in slide_xml and 'B2' in slide_xml
+
+
+def test_waterfall_data_edit(tmp_path):
+    pptx = tmp_path / 'test_chart.pptx'
+    _make_minimal_pptx_with_chart(str(pptx))
+
+    editor = PowerPointEditor(str(pptx))
+    editor.edit_waterfall_data_on_slide(1, 'TestChart', ['NewOne', 'NewTwo'], [11, 22])
+
+    chart_xml = editor.files['ppt/charts/chart1.xml'].decode('utf-8')
+    assert 'NewOne' in chart_xml
+    assert '22' in chart_xml
+
+
+def test_embedded_workbook_for_chart_on_slide(tmp_path):
+    pptx = tmp_path / 'test_embedded_chart.pptx'
+    _make_minimal_pptx_with_chart(str(pptx))
+
+    editor = PowerPointEditor(str(pptx))
+    editor.edit_embedded_workbook_for_chart_on_slide(
+        slide_number=1,
+        chart_name='TestChart',
+        categories=['CatA', 'CatB'],
+        values=[100, 200],
+        sheet_name='Sheet1',
+    )
+
+    chart_xml = editor.files['ppt/charts/chart1.xml'].decode('utf-8')
+    assert 'CatA' in chart_xml
+    assert '200' in chart_xml
+
+    rels = etree.fromstring(editor.files['ppt/charts/_rels/chart1.xml.rels'])
+    workbook_target = rels.xpath('./pr:Relationship', namespaces=edmod.NS)[0].get('Target')
+    workbook_path = PowerPointEditor._normalize_relationship_target('ppt/charts/chart1.xml', workbook_target)
+    workbook_data = editor.files[workbook_path]
+
+    loaded_wb = load_workbook(BytesIO(workbook_data))
+    sheet = loaded_wb['Sheet1']
+    assert sheet['A2'].value == 'CatA'
+    assert sheet['B3'].value == 200

xmlppt-0.1.0/xmlppt/__init__.py

@@ -0,0 +1,3 @@
+from .editor import PowerPointEditor
+
+__all__ = ["PowerPointEditor"]