pygixml 0.1.0__tar.gz

pygixml-0.1.0/.github/workflows/wheels.yml

@@ -0,0 +1,123 @@
+name: PYTHON_BUILD_TEST_DEPLOY
+
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches:
+      - master
+    tags:
+      - "v*"
+
+env:
+  FORCE_COLOR: 3
+
+concurrency:
+  group: github.workflow-${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: write
+
+jobs:
+  build_sdist:
+    name: Build SDist
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        submodules: true
+
+    - uses: actions/setup-python@v4
+      with:
+        python-version: "3.x"
+
+    - name: Install build dependencies
+      run: pip install build twine
+
+    - name: Build SDist
+      run: python -m build --sdist
+
+    - name: Check metadata
+      run: twine check dist/*
+
+    - uses: actions/upload-artifact@v4
+      with:
+        path: dist/*.tar.gz
+        overwrite: true
+
+  build_wheels:
+    name: Wheels on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: true
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        submodules: true
+
+    - name: Build wheels
+      uses: pypa/cibuildwheel@v2.16.5
+      env:
+        # Disable building PyPy wheels on all platforms
+        CIBW_SKIP: pp*
+        # Build for all supported Python versions
+        CIBW_BUILD_VERBOSITY: 1
+
+    - name: Verify clean directory
+      run: git diff --exit-code
+      shell: bash
+
+    - uses: actions/upload-artifact@v4
+      with:
+        name: wheelhouse-${{ matrix.os }}
+        path: wheelhouse/*.whl
+        overwrite: false
+
+  release:
+    name: Release Assets and Upload to PyPI
+    needs: [build_wheels, build_sdist]
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && (github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/tags/'))
+
+    steps:
+      # Determine release type
+      - name: Determine release type
+        id: release_type
+        run: |
+          if [[ "${{ github.ref }}" =~ ^refs/tags/v.*$ ]]; then
+            echo "RELEASE_NAME=${GITHUB_REF#refs/tags/}" >> $GITHUB_ENV
+            echo "IS_TAG=true" >> $GITHUB_ENV
+          else
+            echo "RELEASE_NAME=__beta__" >> $GITHUB_ENV
+            echo "IS_TAG=false" >> $GITHUB_ENV
+          fi
+        shell: bash
+
+      - uses: actions/download-artifact@v4
+        with:
+          path: dist
+          merge-multiple: true
+
+      - name: List dist directory
+        run: ls -la dist/
+
+      - name: Create or update release
+        id: create_release
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: ${{ env.RELEASE_NAME }}
+          name: ${{ env.RELEASE_NAME }}
+          draft: false
+          prerelease: ${{ env.IS_TAG }} == 'false'
+          files: dist/*
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Publishing to PyPi
+        uses: pypa/gh-action-pypi-publish@release/v1
+        if: ${{ env.IS_TAG }} == 'true'
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}

pygixml-0.1.0/.gitignore

@@ -0,0 +1,39 @@
+# Build directories
+build/
+dist/
+*.egg-info/
+__pycache__/
+*.pyc
+*.pyo
+*.pyd
+*.so
+
+# CMake
+CMakeCache.txt
+CMakeFiles/
+cmake_install.cmake
+Makefile
+*.cmake
+
+# Development
+*.swp
+*.swo
+*~
+.DS_Store
+
+# Python
+.pytest_cache/
+.coverage
+htmlcov/
+
+# IDE
+.vscode/
+.idea/
+*.sublime-*
+
+# Temporary files
+*.tmp
+*.temp
+
+# Documentation
+docs/_build/

pygixml-0.1.0/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "src/third_party/pugixml"]
+	path = src/third_party/pugixml
+	url = https://github.com/zeux/pugixml.git

pygixml-0.1.0/CMakeLists.txt

@@ -0,0 +1,55 @@
+cmake_minimum_required(VERSION 3.15)
+project(pygixml)
+
+# Set C++ standard
+set(CMAKE_CXX_STANDARD 11)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+
+# Optimize for performance
+if(CMAKE_BUILD_TYPE STREQUAL "Release")
+    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -O3 -DNDEBUG")
+else()
+    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -O2")
+endif()
+
+# Additional optimization flags for GCC/Clang
+if(CMAKE_CXX_COMPILER_ID MATCHES "GNU|Clang")
+    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -march=native -mtune=native -fomit-frame-pointer -fno-stack-protector")
+endif()
+
+# Set build type to Release for better performance
+if(NOT CMAKE_BUILD_TYPE)
+    set(CMAKE_BUILD_TYPE Release)
+endif()
+
+list(APPEND CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake")
+
+# Find Python and Cython
+find_package(Python REQUIRED COMPONENTS Interpreter Development.Module)
+find_package(Cython MODULE REQUIRED VERSION 3.0)
+include(UseCython)
+
+# Add pugixml
+add_subdirectory(src/third_party/pugixml)
+
+# Set Python module output directory
+set(PYTHON_MODULE_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/pygixml)
+
+# Transpile Cython to C++
+cython_transpile(src/pygixml/pygixml.pyx LANGUAGE CXX OUTPUT_VARIABLE pygixml_cpp_file)
+
+# Create the Python extension module
+python_add_library(pygixml MODULE "${pygixml_cpp_file}" WITH_SOABI)
+
+# Link pugixml to our module
+target_link_libraries(pygixml PRIVATE pugixml)
+
+# Include directories
+target_include_directories(pygixml PRIVATE 
+    ${CMAKE_CURRENT_SOURCE_DIR}/src/third_party/pugixml/src
+)
+
+# Install the module
+install(TARGETS pygixml
+    DESTINATION .
+)

pygixml-0.1.0/LICENSE

@@ -0,0 +1,24 @@
+MIT License
+
+Copyright (c) 2025 Mohammad Raziei
+
+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:
+
+1. The above copyright notice and this permission notice shall be included in all
+   copies or substantial portions of the Software.
+
+2. **STAR REQUIREMENT**: To use this software, you must star the project on GitHub:
+   https://github.com/MohammadRaziei/pygixml
+
+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.

pygixml-0.1.0/PKG-INFO

@@ -0,0 +1,162 @@
+Metadata-Version: 2.2
+Name: pygixml
+Version: 0.1.0
+Summary: Python wrapper for pugixml using Cython - Please star the project on GitHub to use!
+Keywords: xml,pugixml,cython,wrapper
+Author-Email: Mohammad Raziei <mohammadraziei1375@gmail.com>
+License: MIT
+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.8
+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.8
+Provides-Extra: test
+Requires-Dist: pytest>=7.0.0; extra == "test"
+Requires-Dist: pytest-xdist>=3.0.0; extra == "test"
+Requires-Dist: pytest-timeout>=2.0.0; extra == "test"
+Description-Content-Type: text/markdown
+
+# pygixml
+
+[![Python Version](https://img.shields.io/badge/python-3.8%2B-blue)](https://www.python.org/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Build Status](https://github.com/MohammadRaziei/pygixml/actions/workflows/python.yml/badge.svg)](https://github.com/MohammadRaziei/pygixml/actions)
+[![GitHub Stars](https://img.shields.io/github/stars/MohammadRaziei/pygixml?style=social)](https://github.com/MohammadRaziei/pygixml)
+
+A high-performance Python wrapper for [pugixml](https://pugixml.org/) using Cython, providing fast XML parsing and manipulation capabilities.
+
+
+
+## 🚀 Performance
+
+pygixml delivers exceptional performance compared to other XML libraries:
+
+### Performance Comparison (5000 XML elements)
+
+| Library | Parsing Time | Speedup vs ElementTree |
+|---------|--------------|------------------------|
+| **pygixml** | 0.00077s | **15.9x faster** |
+| **lxml** | 0.00407s | 3.0x faster |
+| **ElementTree** | 0.01220s | 1.0x (baseline) |
+
+![Performance Comparison](https://github.com/MohammadRaziei/pygixml/raw/master/benchmarks/results/performance_comparison.svg)
+
+### Key Performance Highlights
+
+- **15.9x faster** than Python's ElementTree for XML parsing
+- **5.3x faster** than lxml for XML parsing  
+- **Memory efficient** - uses pugixml's optimized C++ memory management
+- **Scalable performance** - maintains speed advantage across different XML sizes
+
+## Installation
+
+### From Pypi repositoey
+```bash
+pip install pygixml
+```
+
+### From Source
+```bash
+git clone --recurse-submodules https://github.com/MohammadRaziei/pygixml.git
+pip install ./pygixml
+```
+
+### Development Installation
+```bash
+pip install ./pygixml[test]
+```
+
+## Quick SWtart
+
+```python
+import pygixml
+
+# Parse XML from string
+xml_string = """
+<library>
+    <book id="1">
+        <title>The Great Gatsby</title>
+        <author>F. Scott Fitzgerald</author>
+        <year>1925</year>
+    </book>
+</library>
+"""
+
+doc = pygixml.parse_string(xml_string)
+root = doc.first_child()
+
+# Access elements
+book = root.first_child()
+title = book.child("title")
+print(f"Title: {title.child_value()}")  # Output: Title: The Great Gatsby
+
+# Create new XML
+doc = pygixml.XMLDocument()
+root = doc.append_child("catalog")
+product = root.append_child("product")
+product.append_child("name").set_value("Laptop")
+product.append_child("price").set_value("999.99")
+
+# Save to file
+doc.save_file("output.xml")
+```
+
+## API Overview
+
+### Core Classes
+
+- **XMLDocument**: Create, parse, save XML documents
+- **XMLNode**: Navigate and manipulate XML nodes  
+- **XMLAttribute**: Handle XML attributes
+
+### Key Methods
+
+- `parse_string(xml_string)` - Parse XML from string
+- `parse_file(file_path)` - Parse XML from file
+- `save_file(file_path)` - Save XML to file
+- `append_child(name)` - Add child node
+- `child(name)` - Get child by name
+- `child_value()` - Get node value
+- `attribute(name)` - Get attribute
+
+## Benchmarks
+
+Run performance comparisons:
+
+```bash
+# Run complete benchmark suite
+python benchmarks/clean_visualization.py
+
+# View results
+cat benchmarks/results/benchmark_results.csv
+```
+
+The benchmark suite compares pygixml against:
+- **lxml** - Industry-standard C-based parser
+- **xml.etree.ElementTree** - Python standard library
+
+**Benchmark Files:**
+- `benchmarks/clean_visualization.py` - Main benchmark runner
+- `benchmarks/benchmark_parsing.py` - Core benchmark logic
+- `benchmarks/results/` - Generated CSV data and SVG charts
+
+## License
+
+MIT License - see [LICENSE](LICENSE) file for details.
+
+**To use this library, you must star the project on GitHub!**
+
+This helps support the development and shows appreciation for the work. Please star the repository before using the library:
+
+👉 **[Star pygixml on GitHub](https://github.com/MohammadRaziei/pygixml)**
+
+## Acknowledgments
+
+- [pugixml](https://pugixml.org/) - Fast and lightweight C++ XML processing library
+- [Cython](https://cython.org/) - C extensions for Python
+- [scikit-build](https://scikit-build.readthedocs.io/) - Modern Python build system

pygixml-0.1.0/README.md

@@ -0,0 +1,139 @@
+# pygixml
+
+[![Python Version](https://img.shields.io/badge/python-3.8%2B-blue)](https://www.python.org/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Build Status](https://github.com/MohammadRaziei/pygixml/actions/workflows/python.yml/badge.svg)](https://github.com/MohammadRaziei/pygixml/actions)
+[![GitHub Stars](https://img.shields.io/github/stars/MohammadRaziei/pygixml?style=social)](https://github.com/MohammadRaziei/pygixml)
+
+A high-performance Python wrapper for [pugixml](https://pugixml.org/) using Cython, providing fast XML parsing and manipulation capabilities.
+
+
+
+## 🚀 Performance
+
+pygixml delivers exceptional performance compared to other XML libraries:
+
+### Performance Comparison (5000 XML elements)
+
+| Library | Parsing Time | Speedup vs ElementTree |
+|---------|--------------|------------------------|
+| **pygixml** | 0.00077s | **15.9x faster** |
+| **lxml** | 0.00407s | 3.0x faster |
+| **ElementTree** | 0.01220s | 1.0x (baseline) |
+
+![Performance Comparison](https://github.com/MohammadRaziei/pygixml/raw/master/benchmarks/results/performance_comparison.svg)
+
+### Key Performance Highlights
+
+- **15.9x faster** than Python's ElementTree for XML parsing
+- **5.3x faster** than lxml for XML parsing  
+- **Memory efficient** - uses pugixml's optimized C++ memory management
+- **Scalable performance** - maintains speed advantage across different XML sizes
+
+## Installation
+
+### From Pypi repositoey
+```bash
+pip install pygixml
+```
+
+### From Source
+```bash
+git clone --recurse-submodules https://github.com/MohammadRaziei/pygixml.git
+pip install ./pygixml
+```
+
+### Development Installation
+```bash
+pip install ./pygixml[test]
+```
+
+## Quick SWtart
+
+```python
+import pygixml
+
+# Parse XML from string
+xml_string = """
+<library>
+    <book id="1">
+        <title>The Great Gatsby</title>
+        <author>F. Scott Fitzgerald</author>
+        <year>1925</year>
+    </book>
+</library>
+"""
+
+doc = pygixml.parse_string(xml_string)
+root = doc.first_child()
+
+# Access elements
+book = root.first_child()
+title = book.child("title")
+print(f"Title: {title.child_value()}")  # Output: Title: The Great Gatsby
+
+# Create new XML
+doc = pygixml.XMLDocument()
+root = doc.append_child("catalog")
+product = root.append_child("product")
+product.append_child("name").set_value("Laptop")
+product.append_child("price").set_value("999.99")
+
+# Save to file
+doc.save_file("output.xml")
+```
+
+## API Overview
+
+### Core Classes
+
+- **XMLDocument**: Create, parse, save XML documents
+- **XMLNode**: Navigate and manipulate XML nodes  
+- **XMLAttribute**: Handle XML attributes
+
+### Key Methods
+
+- `parse_string(xml_string)` - Parse XML from string
+- `parse_file(file_path)` - Parse XML from file
+- `save_file(file_path)` - Save XML to file
+- `append_child(name)` - Add child node
+- `child(name)` - Get child by name
+- `child_value()` - Get node value
+- `attribute(name)` - Get attribute
+
+## Benchmarks
+
+Run performance comparisons:
+
+```bash
+# Run complete benchmark suite
+python benchmarks/clean_visualization.py
+
+# View results
+cat benchmarks/results/benchmark_results.csv
+```
+
+The benchmark suite compares pygixml against:
+- **lxml** - Industry-standard C-based parser
+- **xml.etree.ElementTree** - Python standard library
+
+**Benchmark Files:**
+- `benchmarks/clean_visualization.py` - Main benchmark runner
+- `benchmarks/benchmark_parsing.py` - Core benchmark logic
+- `benchmarks/results/` - Generated CSV data and SVG charts
+
+## License
+
+MIT License - see [LICENSE](LICENSE) file for details.
+
+**To use this library, you must star the project on GitHub!**
+
+This helps support the development and shows appreciation for the work. Please star the repository before using the library:
+
+👉 **[Star pygixml on GitHub](https://github.com/MohammadRaziei/pygixml)**
+
+## Acknowledgments
+
+- [pugixml](https://pugixml.org/) - Fast and lightweight C++ XML processing library
+- [Cython](https://cython.org/) - C extensions for Python
+- [scikit-build](https://scikit-build.readthedocs.io/) - Modern Python build system