{"author":null,"author_email":null,"bugtrack_url":null,"classifiers":["Intended Audience :: Developers","License :: OSI Approved :: Apache Software License","License :: OSI Approved :: GNU General Public License v2 (GPLv2)","Natural Language :: English","Operating System :: OS Independent","Programming Language :: Python","Programming Language :: Python :: 3","Topic :: Software Development :: Build Tools"],"description":"# `pyinstaller-hooks-contrib`: The PyInstaller community hooks repository\n\nWhat happens when (your?) package doesn't work with PyInstaller? Say you have data files that you need at runtime?\nPyInstaller doesn't bundle those. Your package requires others which PyInstaller can't see? How do you fix that?\n\nIn summary, a \"hook\" file extends PyInstaller to adapt it to the special needs and methods used by a Python package.\nThe word \"hook\" is used for two kinds of files. A runtime hook helps the bootloader to launch an app, setting up the\nenvironment. A package hook (there are several types of those) tells PyInstaller what to include in the final app -\nsuch as the data files and (hidden) imports mentioned above.\n\nThis repository is a collection of hooks for many packages, and allows PyInstaller to work with these packages\nseamlessly.\n\n\n## Installation\n\n`pyinstaller-hooks-contrib` is automatically installed when you install PyInstaller, or can be installed with pip:\n\n```commandline\npip install -U pyinstaller-hooks-contrib\n```\n\n\n## I can't see a hook for `a-package`\n\nEither `a-package` works fine without a hook, or no-one has contributed hooks.\nIf you'd like to add a hook, or view information about hooks,\nplease see below.\n\n\n## Hook configuration (options)\n\nHooks that support configuration (options) and their options are documented in\n[Supported hooks and options](hooks-config.rst).\n\n\n## I want to help!\n\nIf you've got a hook you want to share then great!\nThe rest of this page will walk you through the process of contributing a hook.\nIf you've been here before then you may want to skip to the [summary checklist](#summary)\n\n**Unless you are very comfortable with `git rebase -i`, please provide one hook per pull request!**\n**If you have more than one then submit them in separate pull requests.**\n\n\n### Setup\n\n[Fork this repo](https://github.com/pyinstaller/pyinstaller-hooks-contrib/fork) if you haven't already done so.\n(If you have a fork already but its old, click the **Fetch upstream** button on your fork's homepage.)\nClone and `cd` inside your fork by running the following (replacing `bob-the-barnacle` with your github username):\n\n```\ngit clone https://github.com/bob-the-barnacle/pyinstaller-hoooks-contrib.git\ncd pyinstaller-hooks-contrib\n```\n\nCreate a new branch for you changes (replacing `foo` with the name of the package):\nYou can name this branch whatever you like.\n\n```\ngit checkout -b hook-for-foo\n```\n\nIf you wish to create a virtual environment then do it now before proceeding to the next step.\n\nInstall this repo in editable mode.\nThis will overwrite your current installation.\n(Note that you can reverse this with `pip install --force-reinstall pyinstaller-hooks-contrib`).\n\n```\npip install -e .\npip install -r requirements-test.txt\npip install flake8 pyinstaller\n```\n\nNote that on macOS and Linux, `pip` may by called `pip3`.\nIf you normally use `pip3` and `python3` then use `pip3` here too.\nYou may skip the 2^nd line if you have no intention of providing tests (but please do provide tests!).\n\n\n### Add the hook\n\nStandard hooks live in the [_pyinstaller_hooks_contrib/stdhooks/](../master/_pyinstaller_hooks_contrib/stdhooks/) directory.\nRuntime hooks live in the [_pyinstaller_hooks_contrib/rthooks/](../master/_pyinstaller_hooks_contrib/rthooks/) directory.\nSimply copy your hook into there.\nIf you're unsure if your hook is a runtime hook then it almost certainly is a standard hook.\n\nPlease annotate (with comments) anything unusual in the hook.\n*Unusual* here is defined as any of the following:\n\n* Long lists of `hiddenimport` submodules.\n If you need lots of hidden imports then use [`collect_submodules('foo')`](https://pyinstaller.readthedocs.io/en/latest/hooks.html#PyInstaller.utils.hooks.collect_submodules).\n For bonus points, track down why so many submodules are hidden. Typical causes are:\n * Lazily loaded submodules (`importlib.importmodule()` inside a module `__getattr__()`).\n * Dynamically loaded *backends*.\n * Usage of `Cython` or Python extension modules containing `import` statements.\n* Use of [`collect_all()`](https://pyinstaller.readthedocs.io/en/latest/hooks.html#PyInstaller.utils.hooks.collect_all).\n This function's performance is abismal and [it is broken by\n design](https://github.com/pyinstaller/pyinstaller/issues/6458#issuecomment-1000481631) because it confuses\n packages with distributions.\n Check that you really do need to collect all of submodules, data files, binaries, metadata and dependencies.\n If you do then add a comment to say so (and if you know it - why).\n Do not simply use `collect_all()` just to *future proof* the hook.\n* Any complicated `os.path` arithmetic (by which I simply mean overly complex filename manipulations).\n\n\n#### Add the copyright header\n\nAll source files must contain the copyright header to be covered by our terms and conditions.\n\nIf you are **adding** a new hook (or any new python file), copy/paste the appropriate copyright header (below) at the top\nreplacing 2021 with the current year.\n\n

GPL 2 header for standard hooks or other Python files.

\n\n```python\n# ------------------------------------------------------------------\n# Copyright (c) 2024 PyInstaller Development Team.\n#\n# This file is distributed under the terms of the GNU General Public\n# License (version 2.0 or later).\n#\n# The full license is available in LICENSE, distributed with\n# this software.\n#\n# SPDX-License-Identifier: GPL-2.0-or-later\n# ------------------------------------------------------------------\n```\n\n

\n\n

Apache header for runtime hooks only.\nAgain, if you're unsure if your hook is a runtime hook then it'll be a standard hook.

\n\n```python\n# ------------------------------------------------------------------\n# Copyright (c) 2024 PyInstaller Development Team.\n#\n# This file is distributed under the terms of the Apache License 2.0\n#\n# The full license is available in LICENSE, distributed with\n# this software.\n#\n# SPDX-License-Identifier: Apache-2.0\n# ------------------------------------------------------------------\n```\n\n

\n\n\nIf you are **updating** a hook, skip this step.\nDo not update the year of the copyright header - even if it's out of date.\n\n\n### Test\n\nHaving tests is key to our continuous integration.\nWith them we can automatically verify that your hook works on all platforms, all Python versions and new versions of\nlibraries as and when they are released.\nWithout them, we have no idea if the hook is broken until someone finds out the hard way.\nPlease write tests!!!\n\nSome user interface libraries may be impossible to test without user interaction\nor a wrapper library for some web API may require credentials (and possibly a paid subscription) to test.\nIn such cases, don't provide a test.\nInstead explain either in the commit message or when you open your pull request why an automatic test is impractical\nthen skip on to [the next step](#run-linter).\n\n\n#### Write tests(s)\n\nA test should be the least amount of code required to cause a breakage\nif you do not have the hook which you are contributing.\nFor example if you are writing a hook for a library called `foo`\nwhich crashes immediately under PyInstaller on `import foo` then `import foo` is your test.\nIf `import foo` works even without the hook then you will have to get a bit more creative.\nGood sources of such minimal tests are introductory examples\nfrom the documentation of whichever library you're writing a hook for.\nPackage's internal data files and hidden dependencies are prone to moving around so\ntests should not explicitly check for presence of data files or hidden modules directly -\nrather they should use parts of the library which are expected to use said data files or hidden modules.\n\nTests generally live in [tests/test_libraries.py](../master/tests/test_libraries.py).\nNavigate there and add something like the following, replacing all occurrences of `foo` with the real name of the library.\n(Note where you put it in that file doesn't matter.)\n\n```python\n@importorskip('foo')\ndef test_foo(pyi_builder):\n pyi_builder.test_source(\"\"\"\n\n # Your test here!\n import foo\n\n foo.something_fooey()\n\n \"\"\")\n```\n\nIf the library has changed significantly over past versions then you may need to add version constraints to the test.\nTo do that, replace the `@importorskip(\"foo\")` with a call to `PyInstaller.utils.tests.requires()` (e.g.\n`@requires(\"foo >= 1.4\")`) to only run the test if the given version constraint is satisfied.\nNote that `@importorskip` uses module names (something you'd `import`) whereas `@requires` uses distribution names\n(something you'd `pip install`) so you'd use `@importorskip(\"PIL\")` but `@requires(\"pillow\")`.\nFor most packages, the distribution and packages names are the same.\n\n\n#### Run the test locally\n\nRunning our full test suite is not recommended as it will spend a very long time testing code which you have not touched.\nInstead, run tests individually using either the `-k` option to search for test names:\n\n```\npytest -k test_foo\n```\n\nOr using full paths:\n```\npytest tests/test_libraries.py::test_foo\n```\n\n\n#### Pin the test requirement\n\nGet the version of the package you are working with (`pip show foo`)\nand add it to the [requirements-test-libraries.txt](../master/requirements-test-libraries.txt) file.\nThe requirements already in there should guide you on the syntax.\n\n\n#### Run the test on CI/CD\n\n

CI/CD now triggers itself when you open a pull request.\nThese instructions for triggering jobs manually are obsolete except in rare cases.

\n\nTo test hooks on all platforms we use Github's continuous integration (CI/CD).\nOur CI/CD is a bit unusual in that it's triggered manually and takes arguments\nwhich limit which tests are run.\nThis is for the same reason we filter tests when running locally -\nthe full test suite takes ages.\n\nFirst push the changes you've made so far.\n\n```commandline\ngit push --set-upstream origin hook-for-foo\n```\n\nReplace *billy-the-buffalo* with your Github username in the following url then open it.\nIt should take you to the `oneshot-test` actions workflow on your fork.\nYou may be asked if you want to enable actions on your fork - say yes.\n```\nhttps://github.com/billy-the-buffalo/pyinstaller-hooks-contrib/actions/workflows/oneshot-test.yml\n```\n\nFind the **Run workflow** button and click on it.\nIf you can't see the button,\nselect the **Oneshot test** tab from the list of workflows on the left of the page\nand it should appear.\nA dialog should appear containing one drop-down menu and 5 line-edit fields.\nThis dialog is where you specify what to test and which platforms and Python versions to test on.\nIts fields are as follows:\n\n1. A branch to run from. Set this to the branch which you are using (e.g. ``hook-for-foo``),\n2. Which package(s) to install and their version(s).\n Which packages to test are inferred from which packages are installed.\n You can generally just copy your own changes to the `requirements-test-libraries.txt` file into this box.\n * Set to `foo` to test the latest version of `foo`,\n * Set to `foo==1.2, foo==2.3` (note the comma) to test two different versions of `foo` in separate jobs,\n * Set to `foo bar` (note the lack of a comma) to test `foo` and `bar` in the same job,\n3. Which OS or OSs to run on\n * Set to `ubuntu` to test only `ubuntu`,\n * Set to `ubuntu, macos, windows` (order is unimportant) to test all three OSs.\n4. Which Python version(s) to run on\n * Set to `3.9` to test only Python 3.9,\n * Set to `3.8, 3.9, 3.10, 3.11` to test all currently supported version of Python.\n5. The final two options can generally be left alone.\n\nHit the green **Run workflow** button at the bottom of the dialog, wait a few seconds then refresh the page.\nYour workflow run should appear.\n\nWe'll eventually want to see a build (or collection of builds) which pass on\nall OSs and all Python versions.\nOnce you have one, hang onto its URL - you'll need it when you submit the pull request.\nIf you can't get it to work - that's fine.\nOpen a pull request as a draft, show us what you've got and we'll try and help.\n\n\n#### Triggering CI/CD from a terminal\n\nIf you find repeatedly entering the configuration into Github's **Run workflow** dialog arduous\nthen we also have a CLI script to launch it.\nRun ``python scripts/cloud-test.py --help`` which should walk you through it.\nYou will have to enter all the details again but, thanks to the wonders of terminal history,\nrerunning a configuration is just a case of pressing up then enter.\n\n

\n\n\n### Run Linter\n\nWe use `flake8` to enforce code-style.\n`pip install flake8` if you haven't already then run it with the following.\n\n```\nflake8\n```\n\nNo news is good news.\nIf it complains about your changes then do what it asks then run it again.\nIf you don't understand the errors it come up with them lookup the error code\nin each line (a capital letter followed by a number e.g. `W391`).\n\n**Please do not fix flake8 issues found in parts of the repository other than the bit that you are working on.** Not only is it very boring for you, but it is harder for maintainers to\nreview your changes because so many of them are irrelevant to the hook you are adding or changing.\n\n\n### Add a news entry\n\nPlease read [news/README.txt](https://github.com/pyinstaller/pyinstaller-hooks-contrib/blob/master/news/README.txt) before submitting you pull request.\nThis will require you to know the pull request number before you make the pull request.\nYou can usually guess it by adding 1 to the number of [the latest issue or pull request](https://github.com/pyinstaller/pyinstaller-hooks-contrib/issues?q=sort%3Acreated-desc).\nAlternatively, [submit the pull request](#submit-the-pull-request) as a draft,\nthen add, commit and push the news item after you know your pull request number.\n\n\n### Summary\n\nA brief checklist for before submitting your pull request:\n\n* [ ] All new Python files have [the appropriate copyright header](#add-the-copyright-header).\n* [ ] You have written a [news entry](#add-a-news-entry).\n* [ ] Your changes [satisfy the linter](#run-linter) (run `flake8`).\n* [ ] You have written tests (if possible) and [pinned the test requirement](#pin-the-test-requirement).\n\n\n### Submit the pull request\n\nOnce you've done all the above, run `git push --set-upstream origin hook-for-foo` then go ahead and create a pull request.\nIf you're stuck doing any of the above steps, create a draft pull request and explain what's wrong - we'll sort you out...\nFeel free to copy/paste commit messages into the Github pull request title and description.\nIf you've never done a pull request before, note that you can edit it simply by running `git push` again.\nNo need to close the old one and start a new one.\n\n---\n\nIf you plan to contribute frequently or are interested in becoming a developer,\nsend an email to `legorooj@protonmail.com` to let us know.\n","description_content_type":"text/markdown","docs_url":null,"download_url":"https://pypi.org/project/pyinstaller-hooks-contrib","downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":["Description-Content-Type","Download-Url","License-File"],"home_page":"https://github.com/pyinstaller/pyinstaller-hooks-contrib","keywords":"pyinstaller development hooks","license":null,"license_expression":null,"license_files":["LICENSE"],"maintainer":"Legorooj","maintainer_email":"legorooj@protonmail.com","name":"pyinstaller-hooks-contrib","package_url":"https://pypi.org/project/pyinstaller-hooks-contrib/","platform":null,"project_url":"https://pypi.org/project/pyinstaller-hooks-contrib/","project_urls":{"Download":"https://pypi.org/project/pyinstaller-hooks-contrib","Homepage":"https://github.com/pyinstaller/pyinstaller-hooks-contrib"},"provides_extra":null,"release_url":"https://pypi.org/project/pyinstaller-hooks-contrib/2025.4/","requires_dist":["setuptools>=42.0.0","importlib_metadata>=4.6; python_version < \"3.10\"","packaging>=22.0"],"requires_python":">=3.8","summary":"Community maintained hooks for PyInstaller","version":"2025.4","yanked":false,"yanked_reason":null}

Dependencies of pyinstaller-hooks-contrib (3).
Dependency	Optional
importlib_metadata	false
packaging	false
setuptools	false

Package search

pyinstaller-hooks-contrib

project_urls

Dependencies

All package metadata

Releases