pypa / pypa/setuptools

Ability to copy scripts unmodified

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

Nobody has claimed this yet.

enhancement minor Needs Triage
Dominant language
Python
Stars
2.9k
Forks
1.4k
Avg merge
1d 1h
Merged PRs (30d)
1

Description

Originally reported by: hut2 (Bitbucket: hut2, GitHub: Unknown)


I use a setup.py script like

#!python

from setuptools import setup
setup(
    scripts=['scripts/ranger', 'scripts/rifle']
   ...)

Now the script scripts/ranger contains an embedded polyglot shell script to enable an extra feature. That's why I need it to be copied as is. Distutils did that, but setuptools creates a file like this, which lacks the embedded shell script, disabling the extra feature:

#!python
#!/usr/bin/python3
# EASY-INSTALL-SCRIPT: 'ranger==1.7.1','rifle'
__requires__ = 'ranger==1.7.1'
__import__('pkg_resources').run_script('ranger==1.7.1', 'rifle')

The script I'm talking about is this one: https://github.com/hut/ranger/blob/df64986fea91c9103baa1a07c5021cc0b4bb7a6f/ranger.py . Is there some way to get this to work with setuptools?


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 setup.py scripts=['scripts/ranger', 'scripts/rifle'] declaration and compare the installed result with scripts/ranger and ranger.py. Check how the EASY-INSTALL-SCRIPT wrapper changes the file, then determine what behavior preserves the embedded shell script; done means the script is copied and remains functional after installation.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.