https://github.com/va1da5/python-application-bundle
Example of packaging Python application as an executable ZIP archive
https://github.com/va1da5/python-application-bundle
bundle fastapi packaging python zip zipapp
Last synced: about 1 month ago
JSON representation
Example of packaging Python application as an executable ZIP archive
- Host: GitHub
- URL: https://github.com/va1da5/python-application-bundle
- Owner: va1da5
- Created: 2022-01-20T18:43:14.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-01-21T18:15:44.000Z (over 4 years ago)
- Last Synced: 2024-12-28T07:31:33.359Z (over 1 year ago)
- Topics: bundle, fastapi, packaging, python, zip, zipapp
- Language: JavaScript
- Homepage:
- Size: 17.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Bundle Python Application Using Zip
This is a small proof-of-concept (PoC) setup for packaging application as a single Python executable ZIP archive.
The idea is that the archive includes all (*most*) of the dependencies of the application and could be easily distributed to other interested parties.
A minimal [FastAPI](https://fastapi.tiangolo.com/) setup is used to simulate an application with a number of dependencies, like [Uvicorn server](https://www.uvicorn.org/).
Python includes an awesome utility module [zipapp](https://docs.python.org/3/library/zipapp.html) for packaging the application, however this example uses [the standard zip command line utility](https://linux.die.net/man/1/zip) to bundle up the application. This is because the PoC uses a custom [`__main__.py`](__main__.py) file which updates `sys.path` list, because the dependencies are placed in a dedicated directory `./site-packages` that are not part of the standard locations where Python looks for modules.
## Results
The archived Python code gets executed. However, there are issues with static assets that are later used by code. [There are ways to access the files from archived modules](https://stackoverflow.com/questions/6028000/how-to-read-a-static-file-from-inside-a-python-package), but libraries like [FastAPI](https://fastapi.tiangolo.com/) or [Django](https://www.djangoproject.com/) do not take such setup into account and the static file loading fails.
This is something to be aware and evaluate before developing application with intend to distribute it as an executable archive.
**Possible solutions**:
- Write utility function which would extract contents of the archive into some temporary location and allow code to access files from there;
- Implement an abstraction layer that would take ZIP archive and simply emulate it as a directory within regular filesystem.
The possible solution are out of the scope for this PoC.
## Application Packaging
```bash
# create a temporary locations for bundling the application
mkdir -p .tmp/ build
# copy the application code to the temporary location
cp -r *.py public server .tmp/
# install required dependencies to a dedicated directory
pip install -r requirements.txt --target .tmp/site-packages
# bundle up the application with dependencies
cd .tmp/
zip -r9 ../build/server.pyz .
cd ..
# run the application
python3 ./build/server.pyz
# make archive executable on its own
mv ./build/server.pyz ./build/server.pyz.tmp
echo '#!/usr/bin/env python3' > ./build/server.pyz
cat ./build/server.pyz.tmp >> ./build/server.pyz
rm ./build/server.pyz.tmp
chmod +x ./build/server.pyz
# start the application
./build/server.pyz
# the service could also be started using standard Uvicorn command
# Python path needs to be updated to point to the bundled application internals
PYTHONPATH="./build/server.pyz/site-packages:./build/server.pyz" python -m uvicorn server:app --host localhost --port 4000
# most of the actions could be performed using Make utility
make
Usage: make [build|clean|run|dev]
build : creates the application bundle
clean : removes all traces of build artifacts
run : runs built application
dev : runs the application in development mode
```
## References
- [Python zipapp](https://docs.python.org/3/library/zipapp.html)
- [Python's zipapp: Build Executable Zip Applications](https://realpython.com/python-zipapp/)
- [An Overview of Packaging for Python](https://packaging.python.org/en/latest/overview/#bringing-your-own-python-executable)
- [shiv - command line utility for building fully self-contained Python zipapps](https://github.com/linkedin/shiv)
- [How to read a (static) file from inside a Python package?](https://stackoverflow.com/questions/6028000/how-to-read-a-static-file-from-inside-a-python-package)
- [PyFilesystem2’s documentation](https://docs.pyfilesystem.org/en/latest/index.html)