openai / openai/tiktoken

Add Hooks for PyInstaller

Open
#469 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
19.3k
Forks
1.6k
PR merge metrics
No merged PRs in 30d

Description

This is directly related to #43.

Currently, packaging and running the following minimal example with PyInstaller results in a ValueError.

from tiktoken import get_encoding

get_encoding("o200k_base")

This is caused by a hidden import for tiktoken_ext.openai_public not being detected by PyInstaller.

The current workaround for users is to include --hidden-import tiktoken_ext.openai_public in the PyInstaller command.

A proper fix for this would be for tiktoken to include a PyInstaller hook to make sure relevant files are collected. Documentation for adding hooks can be found here: https://pyinstaller.org/en/stable/hooks.html It is quite possible to specify hidden imports in the hook.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the minimal PyInstaller example in the issue and read PyInstaller's hooks documentation. Locate tiktoken's packaging configuration and determine where a hook for the hidden import tiktoken_ext.openai_public belongs. Done means the example packages and runs with PyInstaller without requiring --hidden-import.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.