compress-utils 0.4.1__tar.gz

compress_utils-0.4.1/.clang-format

@@ -0,0 +1,35 @@
+BasedOnStyle: Google
+IndentWidth: 4
+TabWidth: 4
+UseTab: Never
+ColumnLimit: 100
+
+IncludeCategories:
+  # 1. The source file's own header (should come first)
+  - Regex: '^"(.*/)?[^/]+\.h"$'
+    Priority: 0  # Highest priority for the source file's own header
+    SortPriority: 0
+    CaseSensitive: false
+  - Regex: '^"(.*/)?[^/]+\.hpp"$'
+    Priority: 0  # Highest priority for the source file's own header
+    SortPriority: 0
+    CaseSensitive: false
+  - Regex: '^"(.*/)?[^/]+\.cuh"$'
+    Priority: 0  # Same priority for .cuh file if it's the corresponding file's header
+    SortPriority: 0
+    CaseSensitive: false
+
+  # 2. C++ Standard Library headers (second)
+  - Regex: '^<.*>$'  # Any header included with angle brackets is considered a system or standard library header
+    Priority: 1
+    SortPriority: 1
+    CaseSensitive: false
+
+  # 3. Other project headers (third)
+  - Regex: '^".*"$'  # All remaining project headers included with double quotes
+    Priority: 2
+    SortPriority: 2
+    CaseSensitive: false
+
+SortIncludes: true  # Keep headers sorted within their priority groups
+IncludeIsMainRegex: '([-_](test|unittest))?$'

compress_utils-0.4.1/.clang-tidy

@@ -0,0 +1,29 @@
+Checks: 'google-*,readability-identifier-naming'
+WarningsAsErrors: ''
+HeaderFilterRegex: '.*'
+FormatStyle: 'file'
+CheckOptions:
+  - { key: readability-identifier-naming.ClassCase,                   value: CamelCase }
+  - { key: readability-identifier-naming.ClassMemberCase,             value: lower_case }
+  - { key: readability-identifier-naming.ConstexprVariableCase,       value: UPPER_CASE }
+  - { key: readability-identifier-naming.EnumCase,                    value: CamelCase }
+  - { key: readability-identifier-naming.EnumConstantCase,            value: CamelCase }
+  - { key: readability-identifier-naming.FunctionCase,                value: CamelCase }
+  - { key: readability-identifier-naming.StaticConstantCase,          value: CamelCase }
+  - { key: readability-identifier-naming.StaticConstantPrefix,        value: k }
+  - { key: readability-identifier-naming.StaticVariableCase,          value: lower_case }
+  - { key: readability-identifier-naming.MacroDefinitionCase,         value: UPPER_CASE }
+  - { key: readability-identifier-naming.MacroDefinitionIgnoredRegexp, value: '^[A-Z]+(_[A-Z]+)*_$' }
+  - { key: readability-identifier-naming.MemberCase,                  value: lower_case }
+  - { key: readability-identifier-naming.PrivateMemberSuffix,         value: _ }
+  - { key: readability-identifier-naming.PublicMemberSuffix,          value: '' }
+  - { key: readability-identifier-naming.NamespaceCase,               value: lower_case }
+  - { key: readability-identifier-naming.ParameterCase,               value: lower_case }
+  - { key: readability-identifier-naming.TypeAliasCase,               value: CamelCase }
+  - { key: readability-identifier-naming.TypedefCase,                 value: CamelCase }
+  - { key: readability-identifier-naming.VariableCase,                value: lower_case }
+  - { key: readability-identifier-naming.IgnoreMainLikeFunctions,     value: 1 }
+  - { key: readability-identifier-naming.StructCase,                  value: CamelCase  }
+  - { key: readability-identifier-naming.GlobalConstantCase,          value: UPPER_CASE }
+  - { key: readability-identifier-naming.ConstantCase,                value: lower_case }
+

compress_utils-0.4.1/.github/workflows/build_and_test_c_cpp.yml

@@ -0,0 +1,196 @@
+name: Build, Test and Package C/C++
+
+on:
+  push:
+    branches: [ "main" ]
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [macos-latest, windows-latest, ubuntu-latest]
+
+    steps:
+    - name: Checkout Code
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+        clean: true
+
+    - name: Configure CMake for C/C++ Language Bindings & All Compressors
+      run: |
+        mkdir build
+        cd build
+        cmake .. -DCMAKE_BUILD_TYPE=Release -DBUILD_PYTHON_BINDINGS=OFF
+
+    - name: Build All Languages
+      run: cmake --build build --config Release -j 4
+
+    - name: Install Bindings
+      run: cmake --install build
+
+    - name: Test All Bindings & Compressors
+      run: |
+        cd build
+        ctest --output-on-failure -C Release
+
+    - name: Zip C Bindings
+      run: |
+        cd dist
+        if [[ "${{ runner.os }}" == "Windows" ]]; then
+          powershell -Command "Compress-Archive -Path c -DestinationPath c-bindings-${{ matrix.os }}.zip"
+        else
+          zip -r c-bindings-${{ matrix.os }}.zip c
+        fi
+      shell: bash
+
+    - name: Zip C++ Bindings
+      run: |
+        cd dist
+        if [[ "${{ runner.os }}" == "Windows" ]]; then
+          powershell -Command "Compress-Archive -Path cpp -DestinationPath cpp-bindings-${{ matrix.os }}.zip"
+        else
+          zip -r cpp-bindings-${{ matrix.os }}.zip cpp
+        fi
+      shell: bash
+
+    - name: Upload C Artifacts
+      uses: actions/upload-artifact@v4
+      with:
+        name: c-bindings-${{ matrix.os }}
+        path: dist/c-bindings-${{ matrix.os }}.zip
+        retention-days: 1  # These artifacts are only used for the `combine` step
+
+    - name: Upload C++ Artifacts
+      uses: actions/upload-artifact@v4
+      with:
+        name: cpp-bindings-${{ matrix.os }}
+        path: dist/cpp-bindings-${{ matrix.os }}.zip
+        retention-days: 1  # These artifacts are only used for the `combine` step
+
+  combine:
+    needs: build
+    runs-on: ubuntu-latest
+
+    steps:
+
+   ##### C Artifacts #####
+
+    - name: Create C Artifact Directories
+      run: mkdir -p compress-utils-c/macos compress-utils-c/linux compress-utils-c/windows
+
+    - name: Download C Artifacts from macOS
+      uses: actions/download-artifact@v4
+      with:
+        name: c-bindings-macos-latest
+        path: compress-utils-c/macos
+
+    - name: Download C Artifacts from Ubuntu
+      uses: actions/download-artifact@v4
+      with:
+        name: c-bindings-ubuntu-latest
+        path: compress-utils-c/linux
+
+    - name: Download C Artifacts from Windows
+      uses: actions/download-artifact@v4
+      with:
+        name: c-bindings-windows-latest
+        path: compress-utils-c/windows
+
+    - name: Unzip C Artifacts from macOS
+      run: |
+        unzip -o compress-utils-c/macos/c-bindings-macos-latest.zip -d compress-utils-c/macos
+        mv compress-utils-c/macos/c/* compress-utils-c/macos/
+        rm -r compress-utils-c/macos/c
+        rm compress-utils-c/macos/c-bindings-macos-latest.zip
+
+    - name: Unzip C Artifacts from Ubuntu
+      run: |
+        unzip -o compress-utils-c/linux/c-bindings-ubuntu-latest.zip -d compress-utils-c/linux
+        mv compress-utils-c/linux/c/* compress-utils-c/linux/
+        rm -r compress-utils-c/linux/c
+        rm compress-utils-c/linux/c-bindings-ubuntu-latest.zip
+      
+    - name: Unzip C Artifacts from Windows
+      run: |
+        set +e
+        unzip -o compress-utils-c/windows/c-bindings-windows-latest.zip -d compress-utils-c/windows
+        unzip_exit_code=$?
+        set -e
+        if [ $unzip_exit_code -gt 1 ]; then exit $unzip_exit_code; fi
+        chmod -R u+rwX,go+rwX compress-utils-c/windows/c
+        mv compress-utils-c/windows/c/* compress-utils-c/windows/
+        rm -r compress-utils-c/windows/c
+        rm compress-utils-c/windows/c-bindings-windows-latest.zip
+
+    ##### C++ Artifacts #####
+
+    - name: Create C++ Artifact Directories
+      run: mkdir -p compress-utils-cpp/macos compress-utils-cpp/linux compress-utils-cpp/windows
+
+    - name: Download C++ Artifacts from macOS
+      uses: actions/download-artifact@v4
+      with:
+        name: cpp-bindings-macos-latest
+        path: compress-utils-cpp/macos
+
+    - name: Download C++ Artifacts from Ubuntu
+      uses: actions/download-artifact@v4
+      with:
+        name: cpp-bindings-ubuntu-latest
+        path: compress-utils-cpp/linux
+
+    - name: Download C++ Artifacts from Windows
+      uses: actions/download-artifact@v4
+      with:
+        name: cpp-bindings-windows-latest
+        path: compress-utils-cpp/windows
+
+    - name: Unzip C++ Artifacts from macOS
+      run: |
+        unzip -o compress-utils-cpp/macos/cpp-bindings-macos-latest.zip -d compress-utils-cpp/macos
+        mv compress-utils-cpp/macos/cpp/* compress-utils-cpp/macos/
+        rm -r compress-utils-cpp/macos/cpp
+        rm compress-utils-cpp/macos/cpp-bindings-macos-latest.zip
+
+    - name: Unzip C++ Artifacts from Ubuntu
+      run: |
+        unzip -o compress-utils-cpp/linux/cpp-bindings-ubuntu-latest.zip -d compress-utils-cpp/linux
+        mv compress-utils-cpp/linux/cpp/* compress-utils-cpp/linux/
+        rm -r compress-utils-cpp/linux/cpp
+        rm compress-utils-cpp/linux/cpp-bindings-ubuntu-latest.zip
+      
+    - name: Unzip C++ Artifacts from Windows
+      run: |
+        set +e
+        unzip -o compress-utils-cpp/windows/cpp-bindings-windows-latest.zip -d compress-utils-cpp/windows
+        unzip_exit_code=$?
+        set -e
+        if [ $unzip_exit_code -gt 1 ]; then exit $unzip_exit_code; fi
+        chmod -R u+rwX,go+rwX compress-utils-cpp/windows/cpp
+        mv compress-utils-cpp/windows/cpp/* compress-utils-cpp/windows/
+        rm -r compress-utils-cpp/windows/cpp
+        rm compress-utils-cpp/windows/cpp-bindings-windows-latest.zip
+
+    ##### Merge All Artifacts #####
+
+    - name: Zip All C Artifacts Together
+      run: zip -r compress-utils-c.zip compress-utils-c
+
+    - name: Zip All C++ Artifacts Together
+      run: zip -r compress-utils-cpp.zip compress-utils-cpp
+
+    ##### Upload Artifacts #####
+
+    - name: Upload Unified C Artifacts
+      uses: actions/upload-artifact@v4
+      with:
+        name: compress-utils-c
+        path: compress-utils-c.zip
+
+    - name: Upload Unified C++ Artifacts
+      uses: actions/upload-artifact@v4
+      with:
+        name: compress-utils-cpp
+        path: compress-utils-cpp.zip

compress_utils-0.4.1/.github/workflows/build_and_test_python.yml

@@ -0,0 +1,113 @@
+name: Build, Test and Package Python Wheels
+
+on:
+  push:
+    branches: ["main"]
+    tags: 
+      - "v*"
+
+jobs:
+  build_wheels:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ["cp36", "cp37", "cp38", "cp39", "cp310", "cp311", "cp312", "cp313"]
+        exclude:
+          # Exclude Python 3.6 - 3.8 on macOS (Apple Silicon incompatible)
+          - os: macos-latest
+            python-version: "cp36"
+          - os: macos-latest
+            python-version: "cp37"
+          - os: macos-latest
+            python-version: "cp38"
+      fail-fast: false
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+
+      - name: Install cibuildwheel and build
+        run: pip install cibuildwheel build
+
+      - name: Copy Python Bindings Configuration
+        run: cp bindings/python/pyproject.toml . && cp bindings/python/setup.py .
+  
+      - name: Build Python Wheels
+        env:
+          CIBW_BUILD_VERBOSITY: 1
+          CIBW_BUILD: "${{ matrix.python-version }}-*"
+          CIBW_ARCHS_LINUX: "x86_64" # TODO - change this to "x86_64 aarch64"
+          CIBW_ARCHS_MACOS: "arm64" # TODO - change this to Universal2
+          CIBW_ARCHS_WINDOWS: "AMD64" # TODO - change this to "AMD64 ARM64"
+        run: cibuildwheel --output-dir wheelhouse
+
+      - name: Build Source Distribution (sdist)
+        if: matrix.os == 'ubuntu-latest' && matrix.python-version == 'cp310'
+        run: python -m build --sdist --outdir wheelhouse
+
+      - name: Upload Wheels as GitHub Artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: wheels-${{ matrix.os }}-${{ matrix.python-version }}
+          path: wheelhouse/*.whl
+          
+      - name: Upload Source Distribution as GitHub Artifact
+        if: matrix.os == 'ubuntu-latest' && matrix.python-version == 'cp310'
+        uses: actions/upload-artifact@v4
+        with:
+          name: python-sdist
+          path: wheelhouse/*.tar.gz
+          retention-days: 5
+
+  publish_to_pypi:
+    needs: build_wheels
+    runs-on: ubuntu-latest
+    if: github.ref_type == 'tag'
+    permissions:
+      id-token: write
+      contents: write
+    
+    steps:
+      - name: Download All Artifacts
+        uses: actions/download-artifact@v4
+        with:
+          path: dist
+
+      - name: Prepare for Upload
+        run: |
+          mkdir -p wheelhouse
+          find dist -type f -name "*.whl" -exec cp {} wheelhouse/ \;
+          find dist -type f -name "*.tar.gz" -exec cp {} wheelhouse/ \; || echo "No source distribution found"
+          ls -la wheelhouse/
+          
+      - name: Create Combined Archive
+        run: |
+          VERSION=${GITHUB_REF_NAME#v}  # Strip the 'v' prefix if present
+          echo "Creating archive for version $VERSION"
+          zip -r compress-utils-python-${VERSION}.zip wheelhouse/
+          echo "RELEASE_VERSION=$VERSION" >> $GITHUB_ENV
+
+      - name: Publish to GitHub Release
+        uses: softprops/action-gh-release@v1
+        with:
+          files: |
+            compress-utils-python-${{ env.RELEASE_VERSION }}.zip
+          generate_release_notes: false
+          fail_on_unmatched_files: false
+          draft: false
+          tag_name: ${{ github.ref_name }}
+          
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: wheelhouse/
+          skip-existing: true

compress_utils-0.4.1/.github/workflows/pr_build_and_test.yml

@@ -0,0 +1,37 @@
+name: Build and Test for PR
+
+on:
+  pull_request:
+    types: [opened, synchronize]
+    branches: [ "main" ]
+
+jobs:
+  build_and_test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [macos-latest, windows-latest, ubuntu-latest]
+
+    steps:
+    - name: Checkout Code
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+        clean: true
+
+    - name: Configure CMake for All Language Bindings & All Compressors
+      run: |
+        mkdir build
+        cd build
+        cmake .. -DCMAKE_BUILD_TYPE=Release
+
+    - name: Build All Languages
+      run: cmake --build build --config Release -j 4
+
+    - name: Install Bindings
+      run: cmake --install build
+
+    - name: Test All Bindings & Compressors
+      run: |
+        cd build
+        ctest --output-on-failure -C Release

compress_utils-0.4.1/.github/workflows/release_artifacts.yml

@@ -0,0 +1,34 @@
+name: Attach Artifacts to Release
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  attach-unified-artifacts:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout Code
+      uses: actions/checkout@v4
+
+    - name: Download Unified C Artifact
+      uses: actions/download-artifact@v4
+      with:
+        name: compress-utils-c
+        path: ./dist
+
+    - name: Download Unified C++ Artifact
+      uses: actions/download-artifact@v4
+      with:
+        name: compress-utils-cpp
+        path: ./dist
+
+    - name: Attach Unified Artifacts to Release
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      run: |
+        # Get the release ID of the current release
+        release_id=$(gh release view "${{ github.event.release.tag_name }}" --json id --jq '.id')
+        
+        # Upload the artifacts to the release
+        gh release upload "$release_id" ./dist/compress-utils-c.zip ./dist/compress-utils-cpp.zip --clobber

compress_utils-0.4.1/.gitignore

@@ -0,0 +1,47 @@
+# Prerequisites
+*.d
+
+# Compiled Object files
+*.slo
+*.lo
+*.o
+*.obj
+
+# Precompiled Headers
+*.gch
+*.pch
+
+# Compiled Dynamic libraries
+*.so
+*.dylib
+*.dll
+
+# Fortran module files
+*.mod
+*.smod
+
+# Compiled Static libraries
+*.lai
+*.la
+*.a
+*.lib
+
+# Executables
+*.exe
+*.out
+*.app
+
+# Output files
+build/
+dist/
+algorithms/dist/
+algorithms/*/src/
+algorithms/*/build/
+algorithms/*/dist/
+
+# Python
+__pycache__/
+.pytest_cache/
+
+# MacOS
+.DS_Store

compress_utils-0.4.1/.vscode/c_cpp_properties.json

@@ -0,0 +1,27 @@
+{
+    "configurations": [
+        {
+            "name": "compress-utils",
+            "includePath": [
+                "${workspaceFolder}/src",
+                "${workspaceFolder}/algorithms/dist/include",
+                "${workspaceFolder}/build/external/CUnit/include",
+                "/usr/local/include"
+            ],
+            "defines": [
+                "INCLUDE_BROTLI",
+                "INCLUDE_XZ",
+                "INCLUDE_ZLIB",
+                "INCLUDE_ZSTD"
+            ],
+            "macFrameworkPath": [
+                "/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/System/Library/Frameworks"
+            ],
+            "compilerPath": "/usr/bin/clang++",
+            "cStandard": "c17",
+            "cppStandard": "c++20",
+            "intelliSenseMode": "macos-clang-arm64"
+        }
+    ],
+    "version": 4
+}

compress_utils-0.4.1/.vscode/settings.json

@@ -0,0 +1,81 @@
+{
+  "C_Cpp.default.configurationProvider": "ms-vscode.cmake-tools",
+  "C_Cpp.codeAnalysis.clangTidy.enabled": true,
+  "C_Cpp.codeAnalysis.runAutomatically": true,
+  "C_Cpp.codeAnalysis.exclude": {
+    "build/**": true,
+    "build": true,
+    "algorithms/**": true,
+    "algorithms": true
+  },
+  "editor.formatOnSave": true,
+  "files.associations": {
+    "vector": "cpp",
+    "__bit_reference": "cpp",
+    "__hash_table": "cpp",
+    "__locale": "cpp",
+    "__node_handle": "cpp",
+    "__split_buffer": "cpp",
+    "__threading_support": "cpp",
+    "__verbose_abort": "cpp",
+    "array": "cpp",
+    "bitset": "cpp",
+    "cctype": "cpp",
+    "charconv": "cpp",
+    "clocale": "cpp",
+    "cmath": "cpp",
+    "complex": "cpp",
+    "cstdarg": "cpp",
+    "cstddef": "cpp",
+    "cstdint": "cpp",
+    "cstdio": "cpp",
+    "cstdlib": "cpp",
+    "cstring": "cpp",
+    "ctime": "cpp",
+    "cwchar": "cpp",
+    "cwctype": "cpp",
+    "deque": "cpp",
+    "execution": "cpp",
+    "memory": "cpp",
+    "forward_list": "cpp",
+    "fstream": "cpp",
+    "initializer_list": "cpp",
+    "iomanip": "cpp",
+    "ios": "cpp",
+    "iosfwd": "cpp",
+    "iostream": "cpp",
+    "istream": "cpp",
+    "limits": "cpp",
+    "locale": "cpp",
+    "mutex": "cpp",
+    "new": "cpp",
+    "optional": "cpp",
+    "ostream": "cpp",
+    "print": "cpp",
+    "queue": "cpp",
+    "ratio": "cpp",
+    "sstream": "cpp",
+    "stack": "cpp",
+    "stdexcept": "cpp",
+    "streambuf": "cpp",
+    "string": "cpp",
+    "string_view": "cpp",
+    "tuple": "cpp",
+    "typeindex": "cpp",
+    "typeinfo": "cpp",
+    "unordered_map": "cpp",
+    "unordered_set": "cpp",
+    "variant": "cpp",
+    "algorithm": "cpp",
+    "__tree": "cpp",
+    "any": "cpp",
+    "cinttypes": "cpp",
+    "condition_variable": "cpp",
+    "map": "cpp",
+    "set": "cpp",
+    "span": "cpp",
+    "csignal": "cpp",
+    "list": "cpp"
+  },
+  "C_Cpp.errorSquiggles": "disabled"
+}

compress_utils-0.4.1/ACKNOWLEDGMENTS.md

@@ -0,0 +1,27 @@
+# Acknowledgements
+
+This project would not be possible without the remarkable work of other engineers in the data compression space. `compress-utils` incorporates such code from the following third-party projects:
+
+## Brotli
+
+- **Repository**: https://github.com/google/brotli.git
+- **License**: MIT License
+- **Authors**: Google and contributors
+
+## zlib
+
+- **Repository**: https://github.com/madler/zlib
+- **License**: zlib License
+- **Authors**: Jean-loup Gailly, Mark Adler and contributors
+
+## Zstandard (zstd)
+
+- **Repository**: https://github.com/facebook/zstd
+- **License**: BSD 3-Clause License
+- **Authors**: Yann Collet and contributors
+
+## XZ Utils
+
+- **Repository**: https://github.com/tukaani-project/xz
+- **License**: BSD 0-Clause License
+- **Authors**: Lasse Collin, Tukaani and contributors