├── .dockerignore ├── COPYING ├── .gitmodules ├── MANIFEST.in ├── .github ├── dependabot.yml └── workflows │ └── build.yml ├── repair.sh ├── .pre-commit-config.yaml ├── tests └── test_patchelf.py ├── noxfile.py ├── CMakeLists.txt ├── .gitignore ├── pyproject.toml ├── README.rst └── LICENSE /.dockerignore: -------------------------------------------------------------------------------- 1 | * 2 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | src/patchelf-upstream/COPYING -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "src/patchelf-upstream"] 2 | path = src/patchelf-upstream 3 | url = https://github.com/NixOS/patchelf.git 4 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include CMakeLists.txt 2 | include COPYING 3 | include LICENSE 4 | include pyproject.toml 5 | include setup.py 6 | graft src/patchelf-upstream 7 | prune src/patchelf-upstream/.git* 8 | exclude src/patchelf-upstream/.git* 9 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | # To get started with Dependabot version updates, you'll need to specify which 2 | # package ecosystems to update and where the package manifests are located. 3 | # Please see the documentation for all configuration options: 4 | # https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates 5 | 6 | version: 2 7 | updates: 8 | # Maintain dependencies for GitHub Actions 9 | - package-ecosystem: "github-actions" 10 | directory: "/" 11 | schedule: 12 | interval: "weekly" 13 | groups: 14 | actions: 15 | patterns: 16 | - "*" 17 | -------------------------------------------------------------------------------- /repair.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | set -euxo pipefail 4 | 5 | WHEEL="$1" 6 | DEST_DIR="$2" 7 | 8 | if [ "${AUDITWHEEL_ARCH}" == "x86_64" ] || [ "${AUDITWHEEL_ARCH}" == "i686" ]; then 9 | PLATFORM_TAG="manylinux1_${AUDITWHEEL_ARCH}.manylinux_2_5_${AUDITWHEEL_ARCH}.musllinux_1_1_${AUDITWHEEL_ARCH}" 10 | elif [ "${AUDITWHEEL_ARCH}" == "riscv64" ]; then 11 | PLATFORM_TAG="manylinux_2_31_${AUDITWHEEL_ARCH}.musllinux_1_1_${AUDITWHEEL_ARCH}" 12 | else 13 | PLATFORM_TAG="manylinux2014_${AUDITWHEEL_ARCH}.manylinux_2_17_${AUDITWHEEL_ARCH}.musllinux_1_1_${AUDITWHEEL_ARCH}" 14 | fi 15 | 16 | cp "${WHEEL}" "${DEST_DIR}/" 17 | pipx run 'wheel>=0.42' tags --remove --platform-tag "${PLATFORM_TAG}" "${DEST_DIR}"/*.whl 18 | -------------------------------------------------------------------------------- /.pre-commit-config.yaml: -------------------------------------------------------------------------------- 1 | repos: 2 | - repo: https://github.com/pre-commit/pre-commit-hooks 3 | rev: v6.0.0 4 | hooks: 5 | - id: check-added-large-files 6 | - id: check-case-conflict 7 | - id: check-merge-conflict 8 | - id: check-symlinks 9 | - id: check-yaml 10 | - id: debug-statements 11 | - id: end-of-file-fixer 12 | - id: mixed-line-ending 13 | - id: requirements-txt-fixer 14 | - id: trailing-whitespace 15 | 16 | - repo: https://github.com/PyCQA/isort 17 | rev: 7.0.0 18 | hooks: 19 | - id: isort 20 | 21 | - repo: https://github.com/asottile/pyupgrade 22 | rev: v3.21.2 23 | hooks: 24 | - id: pyupgrade 25 | 26 | - repo: https://github.com/PyCQA/flake8 27 | rev: 7.3.0 28 | hooks: 29 | - id: flake8 30 | additional_dependencies: [flake8-bugbear] 31 | 32 | ci: 33 | submodules: true 34 | -------------------------------------------------------------------------------- /tests/test_patchelf.py: -------------------------------------------------------------------------------- 1 | import os 2 | import subprocess 3 | 4 | from importlib_metadata import files 5 | 6 | 7 | def which(exe): 8 | path = os.getenv("PATH") 9 | for folder in path.split(os.path.pathsep): 10 | candidate = os.path.join(folder, exe) 11 | if os.path.exists(candidate) and os.access(candidate, os.X_OK): 12 | return os.path.abspath(candidate) 13 | return None 14 | 15 | 16 | def get_script(): 17 | for file in files("patchelf"): 18 | if not file.stem == "patchelf": 19 | continue 20 | if file.parent.name != "bin": 21 | continue 22 | return str(file.locate().resolve(strict=True)) 23 | raise LookupError("Can't find patchelf script") 24 | 25 | 26 | def test_patchelf_script(): 27 | script = get_script() 28 | subprocess.check_call([script, "--version"]) 29 | assert script == which("patchelf") 30 | -------------------------------------------------------------------------------- /noxfile.py: -------------------------------------------------------------------------------- 1 | from pathlib import Path 2 | 3 | import nox 4 | 5 | nox.options.sessions = ["lint", "build", "tests"] 6 | 7 | built = "" 8 | 9 | 10 | @nox.session 11 | def build(session: nox.Session) -> str: 12 | """ 13 | Make an SDist and a wheel. Only runs once. 14 | """ 15 | global built 16 | if not built: 17 | session.log( 18 | "The files produced locally by this job are not intended to be " 19 | "redistributable" 20 | ) 21 | session.install("build") 22 | tmpdir = session.create_tmp() 23 | session.run("python", "-m", "build", "--outdir", tmpdir) 24 | (wheel_path,) = Path(tmpdir).glob("*.whl") 25 | (sdist_path,) = Path(tmpdir).glob("*.tar.gz") 26 | Path("dist").mkdir(exist_ok=True) 27 | wheel_path.rename(f"dist/{wheel_path.name}") 28 | sdist_path.rename(f"dist/{sdist_path.name}") 29 | built = wheel_path.name 30 | return built 31 | 32 | 33 | @nox.session 34 | def lint(session: nox.Session) -> str: 35 | """ 36 | Run linters on the codebase. 37 | """ 38 | session.install("pre-commit") 39 | session.run("pre-commit", "run", "-a") 40 | 41 | 42 | @nox.session 43 | def tests(session: nox.Session) -> str: 44 | """ 45 | Run the tests. 46 | """ 47 | wheel = build(session) 48 | session.install(f"./dist/{wheel}[test]") 49 | session.run("pytest", *session.posargs) 50 | -------------------------------------------------------------------------------- /CMakeLists.txt: -------------------------------------------------------------------------------- 1 | cmake_minimum_required(VERSION 3.15) 2 | 3 | project(PatchelfPythonDistributions) 4 | 5 | option(RUN_PATCHELF_TEST "Run patchelf test suite" OFF) 6 | 7 | set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR} ${CMAKE_MODULE_PATH}) 8 | 9 | #----------------------------------------------------------------------------- 10 | include(ExternalProject) 11 | 12 | #----------------------------------------------------------------------------- 13 | # Build from source 14 | #----------------------------------------------------------------------------- 15 | set(Patchelf_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/src/patchelf-upstream) 16 | find_program(MAKE_EXE NAMES gmake make) 17 | 18 | if(RUN_PATCHELF_TEST) 19 | set(PATCHELF_BUILD_COMMAND "${MAKE_EXE}" check) 20 | else() 21 | set(PATCHELF_BUILD_COMMAND "${MAKE_EXE}") 22 | endif() 23 | 24 | ExternalProject_add(build_patchelf 25 | SOURCE_DIR ${Patchelf_SOURCE_DIR} 26 | DOWNLOAD_COMMAND "" 27 | UPDATE_COMMAND "" 28 | PATCH_COMMAND ./bootstrap.sh 29 | CONFIGURE_COMMAND ./configure 30 | BUILD_COMMAND ${PATCHELF_BUILD_COMMAND} 31 | BUILD_IN_SOURCE 1 32 | INSTALL_COMMAND "" 33 | ) 34 | set(patchelf_executable ${Patchelf_SOURCE_DIR}/src/patchelf${CMAKE_EXECUTABLE_SUFFIX}) 35 | 36 | find_program(STRIP_EXECUTABLE strip) 37 | if(STRIP_EXECUTABLE) 38 | add_custom_target(strip_patchelf_executable ALL 39 | COMMAND ${STRIP_EXECUTABLE} ${patchelf_executable} 40 | WORKING_DIRECTORY ${Patchelf_SOURCE_DIR} 41 | COMMENT "Stripping patchelf executable" 42 | ) 43 | add_dependencies(strip_patchelf_executable build_patchelf) 44 | endif() 45 | 46 | install(PROGRAMS "${patchelf_executable}" COMPONENT python DESTINATION "${SKBUILD_SCRIPTS_DIR}") 47 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | pip-wheel-metadata/ 24 | share/python-wheels/ 25 | *.egg-info/ 26 | .installed.cfg 27 | *.egg 28 | MANIFEST 29 | 30 | # PyInstaller 31 | # Usually these files are written by a python script from a template 32 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 33 | *.manifest 34 | *.spec 35 | 36 | # Installer logs 37 | pip-log.txt 38 | pip-delete-this-directory.txt 39 | 40 | # Unit test / coverage reports 41 | htmlcov/ 42 | .tox/ 43 | .nox/ 44 | .coverage 45 | .coverage.* 46 | .cache 47 | nosetests.xml 48 | coverage.xml 49 | *.cover 50 | *.py,cover 51 | .hypothesis/ 52 | .pytest_cache/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | target/ 76 | 77 | # Jupyter Notebook 78 | .ipynb_checkpoints 79 | 80 | # IPython 81 | profile_default/ 82 | ipython_config.py 83 | 84 | # pyenv 85 | .python-version 86 | 87 | # pipenv 88 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 89 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 90 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 91 | # install all needed dependencies. 92 | #Pipfile.lock 93 | 94 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 95 | __pypackages__/ 96 | 97 | # Celery stuff 98 | celerybeat-schedule 99 | celerybeat.pid 100 | 101 | # SageMath parsed files 102 | *.sage.py 103 | 104 | # Environments 105 | .env 106 | .venv 107 | env/ 108 | venv/ 109 | ENV/ 110 | env.bak/ 111 | venv.bak/ 112 | 113 | # Spyder project settings 114 | .spyderproject 115 | .spyproject 116 | 117 | # Rope project settings 118 | .ropeproject 119 | 120 | # mkdocs documentation 121 | /site 122 | 123 | # mypy 124 | .mypy_cache/ 125 | .dmypy.json 126 | dmypy.json 127 | 128 | # Pyre type checker 129 | .pyre/ 130 | 131 | # cibuildwheel 132 | wheelhouse/ 133 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [build-system] 2 | requires = ["scikit-build-core>=0.10"] 3 | build-backend = "scikit_build_core.build" 4 | 5 | 6 | [project] 7 | name = "patchelf" 8 | dynamic = ["version"] 9 | description = "A small utility to modify the dynamic linker and RPATH of ELF executables." 10 | readme = {file = "README.rst", content-type = "text/x-rst"} 11 | authors = [ 12 | { name = "Matthieu Darbois", email = "mayeut@users.noreply.github.com" }, 13 | ] 14 | keywords = [ 15 | "auditwheel", 16 | "elf", 17 | "manylinux", 18 | "musllinux", 19 | "patchelf", 20 | ] 21 | # license = "Apache-2.0 AND GPL-3.0-or-later" 22 | license = {text = "GPL-3.0-or-later"} 23 | classifiers = [ 24 | "Development Status :: 5 - Production/Stable", 25 | "Intended Audience :: Developers", 26 | "License :: OSI Approved :: Apache Software License", 27 | "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)", 28 | "Operating System :: POSIX :: Linux", 29 | "Programming Language :: C", 30 | "Programming Language :: C++", 31 | "Programming Language :: Python", 32 | "Topic :: Software Development :: Build Tools", 33 | ] 34 | requires-python = ">=3.7" 35 | 36 | [project.optional-dependencies] 37 | test = [ 38 | "importlib_metadata>=2.0", 39 | "pytest>=6.0", 40 | ] 41 | 42 | [project.urls] 43 | "Bug Tracker" = "https://github.com/mayeut/patchelf-pypi/issues" 44 | Homepage = "https://github.com/NixOS/patchelf" 45 | "Source Code" = "https://github.com/mayeut/patchelf-pypi" 46 | 47 | [tool.scikit-build] 48 | minimum-version = "build-system.requires" 49 | cmake.version = "CMakeLists.txt" # Force parsing version from CMakeLists.txt and disable fallback to '>=3.15' 50 | ninja.make-fallback = true 51 | build-dir = "build/{wheel_tag}" 52 | wheel.py-api = "py3" 53 | wheel.expand-macos-universal-tags = true 54 | metadata.version.provider = "scikit_build_core.metadata.setuptools_scm" 55 | install.components = ["python"] 56 | 57 | [tool.setuptools_scm] 58 | 59 | [tool.cibuildwheel] 60 | build = "cp313-musllinux* cp311-macosx_universal2" 61 | build-verbosity = 1 62 | test-extras = "test" 63 | test-command = "pip check && pytest {project}/tests" 64 | 65 | [tool.cibuildwheel.linux] 66 | config-settings = { "cmake.define.RUN_PATCHELF_TEST" = "ON" } 67 | environment = { "CXXFLAGS" = "-D_FORTIFY_SOURCE=2 -fstack-protector-strong -Wformat -Werror=format-security -O2 -static" } 68 | repair-wheel-command = "./repair.sh {wheel} {dest_dir}" 69 | 70 | [tool.cibuildwheel.macos] 71 | environment = { "CXXFLAGS" = "-arch arm64 -arch x86_64 -O2" } 72 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | ============= 2 | patchelf PyPI 3 | ============= 4 | 5 | `patchelf `_ is a small utility to modify the dynamic linker 6 | and RPATH of ELF executables. 7 | 8 | This project allows to get this utility from `PyPI `_ with a simple ``pip install patchelf``. 9 | 10 | Reporting issues 11 | ---------------- 12 | 13 | This repo only aims at providing a rebuild of patchelf on PyPI and as such, 14 | only issues related to this specific packaging will be dealt with in this repository. 15 | 16 | For all issues you might see when using ``patchelf``, please report directly upstream after reproducing with one of their pre-built 17 | binaries or rebuilding patchelf from their repository: https://github.com/NixOS/patchelf 18 | 19 | Latest Release 20 | -------------- 21 | 22 | .. image:: https://img.shields.io/pypi/v/patchelf.svg 23 | :target: https://pypi.python.org/pypi/patchelf 24 | 25 | Build Status 26 | ------------ 27 | 28 | .. image:: https://github.com/mayeut/patchelf-pypi/actions/workflows/build.yml/badge.svg 29 | :target: https://github.com/mayeut/patchelf-pypi/actions/workflows/build.yml 30 | 31 | Platforms 32 | --------- 33 | 34 | The following platforms are supported with binary wheels: 35 | 36 | .. table:: 37 | 38 | +---------------+--------------------------+ 39 | | OS | Arch | 40 | +===============+==========================+ 41 | | Linux x86_64 | | manylinux1+ | 42 | | | | musllinux_1_1+ | 43 | +---------------+--------------------------+ 44 | | Linux i686 | | manylinux1+ | 45 | | | | musllinux_1_1+ | 46 | +---------------+--------------------------+ 47 | | Linux aarch64 | | manylinux2014+ | 48 | | | | musllinux_1_1+ | 49 | +---------------+--------------------------+ 50 | | Linux armv7l | | manylinux2014+ | 51 | | | | musllinux_1_1+ | 52 | +---------------+--------------------------+ 53 | | Linux ppc64le | | manylinux2014+ | 54 | | | | musllinux_1_1+ | 55 | +---------------+--------------------------+ 56 | | Linux s390x | | manylinux2014+ | 57 | | | | musllinux_1_1+ | 58 | +---------------+--------------------------+ 59 | | Linux riscv64 | | manylinux_2_31+ | 60 | | | | musllinux_1_1+ | 61 | +---------------+--------------------------+ 62 | 63 | License 64 | ------- 65 | 66 | This project is covered by the `Apache License, Version 2.0 `_. 67 | 68 | patchelf is distributed under the OSI-approved GNU General Public License v3.0. 69 | For more information about patchelf, visit https://github.com/NixOS/patchelf 70 | -------------------------------------------------------------------------------- /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | 3 | on: 4 | workflow_dispatch: 5 | pull_request: 6 | push: 7 | branches: 8 | - main 9 | tags: 10 | - "*.*.*.*" 11 | 12 | jobs: 13 | lint: 14 | name: Lint 15 | runs-on: ubuntu-24.04 16 | steps: 17 | - uses: actions/checkout@v6 18 | with: 19 | submodules: 'recursive' 20 | - uses: actions/setup-python@v6 21 | with: 22 | python-version: '3.x' 23 | - uses: pre-commit/action@v3.0.1 24 | 25 | 26 | build_wheels: 27 | name: Build ${{ matrix.arch }} wheels 28 | needs: [lint] 29 | runs-on: ${{ matrix.arch == 'universal2' && 'macos-14' || 'ubuntu-24.04' }}${{ startsWith(matrix.docker_arch, 'arm') && '-arm' || '' }} 30 | strategy: 31 | fail-fast: false 32 | matrix: 33 | include: 34 | - arch: "x86_64" 35 | docker_arch: "amd64" 36 | test_image: quay.io/pypa/manylinux1_x86_64 37 | - arch: "i686" 38 | docker_arch: "386" 39 | test_image: quay.io/pypa/manylinux1_i686 40 | - arch: "aarch64" 41 | docker_arch: "arm64" 42 | test_image: quay.io/pypa/manylinux2014_aarch64 43 | - arch: "ppc64le" 44 | docker_arch: "ppc64le" 45 | test_image: quay.io/pypa/manylinux2014_ppc64le 46 | - arch: "s390x" 47 | docker_arch: "s390x" 48 | test_image: quay.io/pypa/manylinux2014_s390x 49 | - arch: "armv7l" 50 | docker_arch: "arm/v7" 51 | test_image: python:3.7-slim-stretch 52 | - arch: "riscv64" 53 | docker_arch: "riscv64" 54 | test_image: quay.io/pypa/manylinux_2_39_riscv64 55 | - arch: "universal2" 56 | docker_arch: "na" 57 | test_image: "na" 58 | 59 | steps: 60 | - uses: actions/checkout@v6 61 | with: 62 | fetch-depth: 0 # required for setuptools_scm to find tags 63 | submodules: 'recursive' 64 | 65 | - name: Set up QEMU 66 | uses: docker/setup-qemu-action@v3.7.0 67 | if: runner.os == 'Linux' 68 | 69 | - name: Install build dependencies 70 | if: runner.os == 'macOS' 71 | run: brew install autoconf automake 72 | 73 | - name: Build wheels 74 | uses: pypa/cibuildwheel@v3.3.0 75 | env: 76 | CIBW_ARCHS: "${{ matrix.arch }}" 77 | 78 | - name: Test wheel on ${{ matrix.test_image }} 79 | if: runner.os == 'Linux' 80 | run: | 81 | cat < check.sh 82 | set -e 83 | set -x 84 | if ! which pipx; then 85 | python3 -m pip install pipx 86 | export PATH=/root/.local/bin:\$PATH 87 | pipx install auditwheel 88 | fi 89 | WHEEL=$(find ./wheelhouse -name 'patchelf-*.whl') 90 | auditwheel show \${WHEEL} 91 | pipx install -f \${WHEEL} 92 | patchelf --version 93 | EOF 94 | docker run --platform linux/${{ matrix.arch == 'i686' && 'amd64' || matrix.docker_arch }} -v $(pwd):/gha ${{ matrix.test_image }} sh -ec "cd /gha && sh ./check.sh" 95 | 96 | - uses: actions/upload-artifact@v6 97 | with: 98 | name: "cibw-wheels-${{ matrix.arch }}" 99 | path: ./wheelhouse/*.whl 100 | 101 | build_sdist: 102 | name: Build source distribution 103 | needs: [lint] 104 | runs-on: ubuntu-24.04 105 | steps: 106 | - uses: actions/checkout@v6 107 | with: 108 | fetch-depth: 0 # required for setuptools_scm to find tags 109 | submodules: 'recursive' 110 | 111 | - name: Build SDist 112 | run: pipx run build --sdist 113 | 114 | - uses: actions/upload-artifact@v6 115 | with: 116 | name: cibw-sdist 117 | path: dist/*.tar.gz 118 | 119 | test_sdist: 120 | name: Test SDist with python ${{ matrix.python }} 121 | needs: [build_sdist] 122 | runs-on: ubuntu-22.04 123 | strategy: 124 | fail-fast: false 125 | matrix: 126 | python: ["3.7", "3.13"] 127 | 128 | steps: 129 | - uses: actions/checkout@v6 130 | - uses: actions/setup-python@v6 131 | name: Install Python ${{ matrix.python }} 132 | with: 133 | python-version: ${{ matrix.python }} 134 | allow-prereleases: true 135 | 136 | - uses: actions/download-artifact@v7 137 | with: 138 | name: cibw-sdist 139 | path: sdist 140 | 141 | - name: Install SDist 142 | run: pip install $(ls sdist/*.tar.gz)[test] 143 | 144 | - name: Test installed SDist 145 | run: pip check && pytest ./tests 146 | 147 | check_dist: 148 | name: Check dist 149 | needs: [build_wheels, build_sdist, test_sdist] 150 | runs-on: ubuntu-24.04 151 | steps: 152 | - uses: actions/download-artifact@v7 153 | with: 154 | pattern: cibw-* 155 | path: dist 156 | merge-multiple: true 157 | 158 | - run: pipx run twine check --strict dist/* 159 | 160 | upload_pypi: 161 | name: Upload to PyPI 162 | needs: [build_wheels, build_sdist, test_sdist, check_dist] 163 | runs-on: ubuntu-24.04 164 | if: github.event_name == 'push' && github.repository == 'mayeut/patchelf-pypi' && startsWith(github.ref, 'refs/tags/') 165 | environment: 166 | name: pypi 167 | url: https://pypi.org/p/patchelf 168 | permissions: 169 | id-token: write 170 | steps: 171 | - uses: actions/download-artifact@v7 172 | with: 173 | pattern: cibw-* 174 | path: dist 175 | merge-multiple: true 176 | 177 | - name: Upload to PyPI 178 | uses: pypa/gh-action-pypi-publish@v1.13.0 179 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------