Skip to content

setup: include shell completions in sdist #4178

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 15, 2021

Conversation

bastimeyer
Copy link
Member

@bastimeyer bastimeyer commented Nov 15, 2021

  • move build directory of the shell completions from /build/shtab to
    /completions due to an sdist restriction of setuptools and MANIFEST.in
  • recursively include the /completions directory in MANIFEST.in
  • update data_files path in setup.py (for inclusion in wheels)
  • update .gitignore

#4048
#4177 (comment)

$ rm -rf src/streamlink.egg-info build/lib
...

$ ./script/build-shell-completions.sh
Completions for bash written to /home/basti/repos/streamlink/completions/bash/streamlink
Completions for zsh written to /home/basti/repos/streamlink/completions/zsh/_streamlink

$ python setup.py clean sdist bdist_wheel
...

$ bsdtar tf dist/streamlink-2.4.0+92.g54356a0.tar.gz | grep -E 'bash|zsh'
streamlink-2.4.0+92.g54356a0/completions/bash/
streamlink-2.4.0+92.g54356a0/completions/bash/streamlink
streamlink-2.4.0+92.g54356a0/completions/zsh/
streamlink-2.4.0+92.g54356a0/completions/zsh/_streamlink

$ bsdtar tf dist/streamlink-2.4.0+92.g54356a0-py3-none-any.whl | grep -E 'bash|zsh'
streamlink-2.4.0+92.g54356a0.data/data/share/bash-completion/completions/streamlink
streamlink-2.4.0+92.g54356a0.data/data/share/zsh/site-functions/_streamlink

- move build directory of the shell completions from /build/shtab to
  /completions due to an sdist restriction of setuptools and MANIFEST.in
- recursively include the /completions directory in MANIFEST.in
- update data_files path in setup.py (for inclusion in wheels)
- update .gitignore
@back-to back-to merged commit 2eb9689 into streamlink:master Nov 15, 2021
@bastimeyer bastimeyer deleted the completions/add-to-sdist branch November 15, 2021 17:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants