Skip to content

Remove sample executable from package install - #2839

Open
kyleoraa wants to merge 1 commit into
ranaroussi:devfrom
kyleoraa:bugfix/unused_console_script
Open

kyleoraa wants to merge 1 commit into
ranaroussi:devfrom
kyleoraa:bugfix/unused_console_script

Conversation

@kyleoraa

@kyleoraa kyleoraa commented Jun 3, 2026

Copy link
Copy Markdown

Currently, the yfinance package includes an executable shim named sample. As this executable shim wraps a non-existent module, this was likely added in error. Given that this executable serves no purpose, as a small item of clean-up, the following change drops this executable from the set of installed artifacts.

Currently, the `yfinance` package includes an executable shim named `sample`.
As this executable shim wraps a non-existent module, this was likely added in
error. Given that this executable serves no purpose, as a small item of
clean-up, the following change drops this executable from the set of installed
artifacts.
@kyleoraa

kyleoraa commented Jun 3, 2026

Copy link
Copy Markdown
Author

While the packaging behavior is well documented and thus, the side-effects of this change should be self-evident, if only to provide some added confidence, please find below some test evidence to support this change:

Before

vscode ➜ /workspaces/yfinance (0940e44) $ pip install .
Defaulting to user installation because normal site-packages is not writeable
Processing ./.
  Installing build dependencies ... done
  Getting requirements to build wheel ... done
  Preparing metadata (pyproject.toml) ... done
…
Building wheels for collected packages: yfinance
  Building wheel for yfinance (pyproject.toml) ... done
  Created wheel for yfinance: filename=yfinance-1.4.0-py2.py3-none-any.whl size=137771 sha256=1307714e27efb1fdcff655caade132b7523def6fe8ac8c4bbb328947a7840094
  Stored in directory: /tmp/pip-ephem-wheel-cache-uka1yju7/wheels/f3/d6/04/7f381e9f9b517714c60b19f4aed9413cbb8f2ad72950547d4e
Successfully built yfinance
Installing collected packages: yfinance
Successfully installed yfinance-1.4.0

vscode ➜ /workspaces/yfinance (0940e44) $ sample
Traceback (most recent call last):
  File "/home/vscode/.local/bin/sample", line 3, in <module>
    from sample import main
ModuleNotFoundError: No module named 'sample'

vscode ➜ /workspaces/yfinance (0940e44) $ which sample
/home/vscode/.local/bin/sample

After

vscode ➜ /workspaces/yfinance (bugfix/unused_console_script) $ pip install .
Defaulting to user installation because normal site-packages is not writeable
Processing ./.
  Installing build dependencies ... done
  Getting requirements to build wheel ... done
  Preparing metadata (pyproject.toml) ... done
…
Building wheels for collected packages: yfinance
  Building wheel for yfinance (pyproject.toml) ... done
  Created wheel for yfinance: filename=yfinance-1.4.0-py2.py3-none-any.whl size=137529 sha256=672ef6feee1bb704ff3f418377652f977a82412eea1f91a5ff664ab9f7fbe5d1
  Stored in directory: /tmp/pip-ephem-wheel-cache-n6r46qxe/wheels/f3/d6/04/7f381e9f9b517714c60b19f4aed9413cbb8f2ad72950547d4e
Successfully built yfinance
Installing collected packages: yfinance
Successfully installed yfinance-1.4.0

vscode ➜ /workspaces/yfinance (bugfix/unused_console_script) $ sample
bash: sample: command not found

@kyleoraa
kyleoraa marked this pull request as ready for review June 3, 2026 22:09
@ValueRaider

Copy link
Copy Markdown
Collaborator

@ranaroussi This was your first commit

@kyleoraa

kyleoraa commented Jun 4, 2026

Copy link
Copy Markdown
Author

@ranaroussi This was your first commit

While I did not want to get too speculative in the commit message, I did observe this as well. Given the similar structure, I strongly suspect it is merely a remnant of the template made available by PyPA around that time.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants