Skip to main content

Convert Python packages into a single script

Project description

Stickytape can be used to convert a Python script and any Python modules it depends on into a single-file Python script.

Since this relies on correctly analysing both your script and any dependent modules, this may not work correctly in all circumstances. I bodged together the code a long time ago for a specific use case I had, so many normal uses of Python imports are not properly supported. If you need to create a standalone executable from your Python script, I recommend using an alternative such as PyInstaller.

Installation

pip install stickytape

Usage

You can tell stickytape which directories to search using the --add-python-path argument. For instance:

stickytape scripts/blah --add-python-path . > /tmp/blah-standalone

Or to output directly to a file:

stickytape scripts/blah --add-python-path . --output-file /tmp/blah-standalone

You can also point stickytape towards a Python binary that it should use sys.path from, for instance the Python binary inside a virtualenv:

stickytape scripts/blah --python-binary _virtualenv/bin/python --output-file /tmp/blah-standalone

Stickytape cannot automatically detect dynamic imports, but you can use --add-python-module to explicitly include modules:

stickytape scripts/blah --add-python-module blah.util

By default, stickytape will ignore the shebang in the script and use "#!/usr/bin/env python" in the output file. To copy the shebang from the original script, use --copy-shebang:

stickytape scripts/blah --copy-shebang --output-file /tmp/blah-standalone

As you might expect with a program that munges source files, there are a few caveats:

  • Due to the way that stickytape generates the output file, your script source file should be encoded using UTF-8. If your script doesn’t declare its encoding in its first two lines, then it will be UTF-8 by default as of Python 3.

  • Your script shouldn’t have any from __future__ imports.

  • Anything that relies on the specific location of files will probably no longer work. In other words, __file__ probably isn’t all that useful.

  • Any files that aren’t imported won’t be included. Static data that might be part of your project, such as other text files or images, won’t be included.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

stickytape-0.2.1.tar.gz (6.3 kB view details)

Uploaded Source

Built Distribution

stickytape-0.2.1-py3-none-any.whl (8.1 kB view details)

Uploaded Python 3

File details

Details for the file stickytape-0.2.1.tar.gz.

File metadata

  • Download URL: stickytape-0.2.1.tar.gz
  • Upload date:
  • Size: 6.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Python-urllib/3.7

File hashes

Hashes for stickytape-0.2.1.tar.gz
Algorithm Hash digest
SHA256 9bbdd5dabed633ffde36bb7f656ee0cb55aeae9f87d9c95e377a06bf1ba7df8d
MD5 8706b5b14eb8aefae22ffaa6a2e53a37
BLAKE2b-256 618c59e35d7b75129ad81544c40922b13a9cfff111b67a4e01829044e1080dad

See more details on using hashes here.

File details

Details for the file stickytape-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: stickytape-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 8.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Python-urllib/3.7

File hashes

Hashes for stickytape-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 66046dedac42484a352d87c12bc4272e4e222260a41f6e1fcbb29876c018e543
MD5 7e88011ebf7d5c4755ee3aec54710417
BLAKE2b-256 1820d44f0e1acbabcd805e3165d143a37cfd575793082635f62a2180524be180

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page